[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 1051 > < TAKE 112 >
112 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| ARCAPI.BaseController | ARCAPI | Class | Contains basic functionality for serving API methods. |
| ARCAPI.BaseController.BuildControllerStorage | ARCAPI | ClassMember | Builds a collection of 'std' (standard) controller instances to use for serving API requests. |
| ARCAPI.BaseController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCAPI.BaseController.CatchAll | ARCAPI | ClassMember | Serves the typical single generic API method in an AgoRapide API. |
| ARCAPI.BaseController.TryNavigateToLevelInDataStorage | ARCAPI | ClassMember | Navigates to the specified level (usually within -Storage-). |
| ARCAPI.BaseController.GetFormatAndAdjustRequest | ARCAPI | ClassMember | Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on). |
| ARCAPI.BaseController.GetTimestampIsOldWarningHTML | ARCAPI | ClassMember | If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format. |
| ARCAPI.BaseController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCAPI.EditController | ARCAPI | Class | Offers a simple HTML editing environment of the raw -PropertyStream- from the given key. |
| ARCAPI.EditController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCAPI.EditController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCAPI.GQController | ARCAPI | Class | Offers GraphQL queries. |
| ARCAPI.GQController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCAPI.GQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCAPI.RQController | ARCAPI | Class | RQ = REST Query. Executes a REST like query request against the given -DataStorage-. |
| ARCAPI.RQController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCAPI.RQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCAPI.DataStorage | ARCAPI | Class | The all-in-memory global application data storage. |
| ARCAPI.DataStorage.Create | ARCAPI | ClassMember | Creates a -DataStorage- instance with default parameters. |
| ARCAPI.DataStorage..ctor | ARCAPI | ClassMember | This method will: |
| ARCAPI.DataStorage.Storage | ARCAPI | ClassMember | The actual storage. |
| ARCAPI.DataStorage.ControllerStorage | ARCAPI | ClassMember | Usually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]). |
| ARCAPI.DataStorage.DocLinks | ARCAPI | ClassMember | Note that may be null. |
| ARCAPI.DataStorage.Lock | ARCAPI | ClassMember | Locking object for thread-safe access from simultaneous API requests. |
| ARCAPI.DataStorage.ExternalReceiver | ARCAPI | ClassMember | Typically used by -AddController-. |
| ARCAPI.DataStorage.DoNotStoreInternally | ARCAPI | ClassMember | Typically used by -AddController-. |
| ARCAPI.BaseControllerP | ARCAPI | Enum | Describes class -BaseController-. |
| ARCAPI.BaseControllerP.CountRequest | ARCAPI | EnumMember | Number of calls to -APIMethod- since application initialization |
| ARCAPI.BaseControllerP.CountException | ARCAPI | EnumMember | Number of exceptions at call to -APIMethod- since application initialization |
| ARCAPI.BaseControllerP.LogLevel | ARCAPI | EnumMember | |
| ARAdventureWorksOLAP.DimProductCategory.ToString | ARAdventureWorksOLAP | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARAdventureWorksOLAP.DimProductCategory.Storage | ARAdventureWorksOLAP | ClassMember | Uses int-value of -__enum- minus 1 as index. |
| ARAdventureWorksOLAP.DimProductSubcategory | ARAdventureWorksOLAP | Class | Represents a ProductSubcategory. See also -DimProductSubcategoryP- and -DimProductSubcategoryCollection-. |
| ARAdventureWorksOLAP.DimProductSubcategory.TryGetName | ARAdventureWorksOLAP | ClassMember | Returns EnglishName. |
| ARAdventureWorksOLAP.DimProductSubcategory.TryGetCategory | ARAdventureWorksOLAP | ClassMember | Returns -EnglishName- through -DimProductCategoryId- with the help of -TryGetForeignField-. |
| ARAdventureWorksOLAP.DimProductSubcategory.SetPVDirect | ARAdventureWorksOLAP | ClassMember | High performance alternative to -TrySetP-, accessing -Storage- more direct. |
| ARAdventureWorksOLAP.DimProductSubcategory.GetPVDirect | ARAdventureWorksOLAP | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
| ARAdventureWorksOLAP.DimProductSubcategory.TryGetPVDirect | ARAdventureWorksOLAP | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
| ARCQuery.NewKeyCountPRec.CountPRec | ARCQuery | ClassMember | Counts recursively the number of properties for a given entity object. |
| ARCQuery.NewKeyCountPRec.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
| ARCQuery.NewKeyCountPRec.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCQuery.NewKeyCountPRec.SyntaxHelp | ARCQuery | ClassMember | 'CountPRec()' |
| ARCQuery.NewKeyCountPRec.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| ARCQuery.NewKeyCountPRec.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCQuery.NewKeyGetType | ARCQuery | Class | Returns the internal C# object type of the given object. |
| ARCQuery.NewKeyGetType.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCQuery.QueryExpressionRel.SyntaxHelp | ARCQuery | ClassMember | 'REL {type}' |
| ARCQuery.QueryExpressionRel.StrType | ARCQuery | ClassMember | In the simplest terms, the -ToStringVeryShort- representation of the type that we are 'jumping' to. |
| ARCQuery.QueryExpressionSelect | ARCQuery | Class | Selects which fields to include. |
| ARCQuery.QueryExpressionSelect.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCQuery.QueryExpressionSelect.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCQuery.QueryExpressionSelect.SyntaxHelp | ARCQuery | ClassMember | SELECT {field-1}, {field-2} ... {field-n} |
| ARCQuery.QueryExpressionSelfCreate | ARCQuery | Class | Returns self created collection from given class type. |
| ARCQuery.QueryExpressionSelfCreate.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCQuery.QueryExpressionSelfCreate.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCQuery.QueryExpressionSelfCreate.SyntaxHelp | ARCQuery | ClassMember | SELFCREATE {Type supporting ISelfCreateCollection}' |
| ARCQuery.QueryExpressionShuffle | ARCQuery | Class | Shuffles collection in random order. |
| ARCQuery.QueryExpressionShuffle.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCQuery.QueryExpressionShuffle.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCQuery.QueryExpressionShuffle.SyntaxHelp | ARCQuery | ClassMember | SHUFFLE |
| ARCQuery.QueryExpressionSkip | ARCQuery | Class | Skips the specified number of elements from the current query result. |
| ARCQuery.QueryExpressionSkip.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCQuery.ValueComparerDateTime.TryParse | ARCQuery | ClassMember | Note: This parser is probably exhaustive but not necessarily logical |
| ARCQuery.ValueComparerDateTime.Resolution | ARCQuery | ClassMember | See -ResolutionEnum-. |
| ARCQuery.ValueComparerDateTime.Steps | ARCQuery | ClassMember | Value 0 would mean 'This', like ThisHour, Today, ThisMonth and so on. |
| ARCQuery.ValueComparerDateTime.IsGliding | ARCQuery | ClassMember | The modifier 'Gliding' (or just 'G') can be appended in order to mean continous gliding periode, so for instance |
| ARCQuery.ValueComparerDateTime.IsBefore | ARCQuery | ClassMember | The modifier 'Before' can be prepended in order to mean from any time before the specified time. |
| ARCQuery.ValueComparerDateTime.IsAfter | ARCQuery | ClassMember | The modifier 'After' can be prepended in order to mean any time after the specified time. |
| ARCQuery.ValueComparerDateTime.IsInterval | ARCQuery | ClassMember | Normally the interval which is compared against is the timespan corresponding to -Resolution-. |
| ARCQuery.ValueComparerDateTime.InitValue | ARCQuery | ClassMember | For debugging purposes. The initial 'now' value used before calculating -StartPeriod- and -EndPeriod-. |
| ARCQuery.ValueComparerDateTime.StartPeriod | ARCQuery | ClassMember | The start of the interval which this instance compares against. |
| ARCQuery.ValueComparerDateTime.EndPeriod | ARCQuery | ClassMember | The end of the interval which this instance compares against. |
| ARCQuery.ValueComparerDateTime.ToDebugProperties | ARCQuery | ClassMember | Exposes all members of this class. |
| ARCQuery.ForeignKey+IKIPEqualityComparer | ARCQuery | Class | Used by -TryGetPInternal- when it needs distinct list of foreign entities, based on their keys |
| ARCQuery.ForeignKey+EntityTypeAndKey | ARCQuery | Class | Describes an entity type and a key. |
| ARCQuery.ForeignKey+EntityTypeAndKey.EntityType | ARCQuery | ClassMember | For -IPRelationsKeysPointingTo-, corresponds to foreign entity type. |
| ARCQuery.ForeignKey+EntityTypeAndKey.Key | ARCQuery | ClassMember | NOTE: Key in EntityTypeAndKey was relaxed from PK to IK 25 Feb 2022 in order for experiment in -ForeignKey- to work. |
| ARCQuery.ForeignKey+EntityTypeAndKey.OppositeTerm | ARCQuery | ClassMember | Corresponds to -PKRelAttributeP-.- OppositeTerm-. |
| ARCAPI.ResponseFormat | ARCAPI | Enum | The response format, HTML or JSON, for an API request. |
| ARCAPI.ResponseFormat.JSON | ARCAPI | EnumMember | |
| ARCAPI.ResponseFormat.HTML | ARCAPI | EnumMember | |
| Assembly ARAdventureWorksOLAP | Assembly | ||
| ARAdventureWorksOLAP.Converter | ARAdventureWorksOLAP | Class | Converts original sample database to property stream format. |
| ARAdventureWorksOLAP.Converter.ConvertDatabase | ARAdventureWorksOLAP | ClassMember | Converts original sample database to property stream format if no data for 'DimCustomer' found. |
| ARAdventureWorksOLAP.DimAccount | ARAdventureWorksOLAP | Class | Represents an Account. See also -DimAccountP- and -DimAccountCollection-. |
| ARAdventureWorksOLAP.DimAccount.SetPVDirect | ARAdventureWorksOLAP | ClassMember | High performance alternative to -TrySetP-, accessing -Storage- more direct. |
| ARAdventureWorksOLAP.DimAccount.GetPVDirect | ARAdventureWorksOLAP | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
| ARAdventureWorksOLAP.DimAccount.TryGetPVDirect | ARAdventureWorksOLAP | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
| ARAdventureWorksOLAP.DimAccount.ToString | ARAdventureWorksOLAP | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARAdventureWorksOLAP.DimAccount.Storage | ARAdventureWorksOLAP | ClassMember | Uses int-value of -__enum- minus 1 as index. |
| ARAdventureWorksOLAP.DimAccountCollection | ARAdventureWorksOLAP | Class | The existence of this class ensures that -Indexing- will be used for foreign key -ParentDimAccountId-. |
| ARAdventureWorksOLAP.DimAccountCollection.TrySetPP | ARAdventureWorksOLAP | ClassMember | Replaces default interface method -TrySetPP-. |
| ARAdventureWorksOLAP.DimAccountCollection.GetKeysEqualToValue | ARAdventureWorksOLAP | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
| ARAdventureWorksOLAP.DimAccountCollection.TryGetP | ARAdventureWorksOLAP | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
| ARAdventureWorksOLAP.DimEmployeeCollection.GetKeysEqualToValue | ARAdventureWorksOLAP | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
| ARAdventureWorksOLAP.DimEmployeeCollection.TryGetP | ARAdventureWorksOLAP | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
| ARAdventureWorksOLAP.DimEmployeeCollection.TryGetV | ARAdventureWorksOLAP | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
| ARAdventureWorksOLAP.DimEmployeeCollection.ToString | ARAdventureWorksOLAP | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARAdventureWorksOLAP.DimGeography | ARAdventureWorksOLAP | Class | Represents a Geography location. See also -DimGeographyP-. |
| ARAdventureWorksOLAP.DimGeography.TryGetCountry | ARAdventureWorksOLAP | ClassMember | Returns EnglishCountryName. |
| ARAdventureWorksOLAP.DimGeography.TryGetState | ARAdventureWorksOLAP | ClassMember | Returns StateOrProvinceName. |
| ARAdventureWorksOLAP.DimGeography.TryGetStateCode | ARAdventureWorksOLAP | ClassMember | Returns StateOrProvinceCode. |
| ARAdventureWorksOLAP.DimCustomer | ARAdventureWorksOLAP | Class | Represents a Customer. See also -DimCustomerP- and -DimCustomerCollection-. |
| ARCQuery.FunctionKeyShort.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARAdventureWorksOLAP.DimCustomer.TryGetName | ARAdventureWorksOLAP | ClassMember | Adds together Title, LastName, FirstName, MiddleName |
| ARCQuery.FunctionKeyShort.SyntaxHelp | ARCQuery | ClassMember | 'Short()' |
| ARAdventureWorksOLAP.DimCustomer.TryGetPostalCode | ARAdventureWorksOLAP | ClassMember | Returns -PostalCode- through -DimGeographyId- with the help of -TryGetForeignField-. |
| ARCQuery.FunctionKeyTMB | ARCQuery | Class | TMB = Thousands, Millions, Billions. |
| ARAdventureWorksOLAP.DimCustomer.TryGetCity | ARAdventureWorksOLAP | ClassMember | Returns -City- through -DimGeographyId- with the help of -TryGetForeignField-. |
| ARCQuery.FunctionKeyTMB.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARAdventureWorksOLAP.DimCustomer.TryGetStateOrProvince | ARAdventureWorksOLAP | ClassMember | Returns -StateOrProvinceName- through -DimGeographyId- with the help of -TryGetForeignField-. |
| ARCQuery.FunctionKeyTMB.SyntaxHelp | ARCQuery | ClassMember | 'TMB()' |
Generated 2026-06-11 19:39:08.380 UTC