[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 812 > < TAKE 124 >
124 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| ARCQuery.FunctionKeyYearQuarter.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCQuery.FunctionKeyYearQuarter.SyntaxHelp | ARCQuery | ClassMember | 'YearQuarter()' |
| ARCQuery.FunctionKeyYearWeek | ARCQuery | Class | Extract year and week number from field according to ISO 8601 like '2021-51' |
| ARCQuery.FunctionKeyYearWeek.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCQuery.FunctionKeyYearWeek.SyntaxHelp | ARCQuery | ClassMember | 'YearWeek()' |
| ARCQuery.NewKey | ARCQuery | Class | A function creating new keys (new fields) that can be used against all object types in AgoRapide (against all entities). |
| ARCQuery.NewKey.AddParser | ARCQuery | ClassMember | Adds a -ApplicationSpecificCode- parser. |
| ARCQuery.NewKey.TryParse | ARCQuery | ClassMember | Find parsers from -Parsers- based on first word in query. |
| ARCQuery.NewKey.TryParseSingleWord | ARCQuery | ClassMember | Recommended parser to use for functions without parameters. |
| ARCQuery.NewKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCQuery.NewKey.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCQuery.NewKey.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
| ARCQuery.NewKey.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| ARCQuery.QuantileKey.TryGetP | ARCQuery | ClassMember | Returns an integer with the number of the quantile group for the value returned by the given -CompoundKey-). |
| ARCQuery.QuantileKey.TryParse | ARCQuery | ClassMember | Note that any value (positive integer greated than 2) is accepted, not necessarily only string-representations of enums within -Quantile-. |
| ARCQuery.Query | ARCQuery | Class | Keeps track of progress of query, and the interim result. |
| ARCQuery.Query.ShouldTerminate | ARCQuery | ClassMember | Attempts to explain problem, in -TerminateReason- and by logging. |
| ARCQuery.Query.ExecuteOne | ARCQuery | ClassMember | NOTE: Note how avoids deferred execution in order to always correctly time execution of each query element separately. |
| ARCQuery.Query.AllLogEntriesForThisQuery | ARCQuery | ClassMember | Temporary storage of log information. |
| ARCQuery.Query.Progress | ARCQuery | ClassMember | Use of member class in order for -Query- not to inherit -IP-. |
| ARCQuery.QueryExpression | ARCQuery | Class | Represents part of a query (or actually a transformation) against a given collection and the data storage from which it was taken. |
| ARCQuery.QueryExpression.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCQuery.QueryExpression.AddParser | ARCQuery | ClassMember | Adds a -ApplicationSpecificCode- parser. |
| ARCQuery.QueryExpression.TryParse | ARCQuery | ClassMember | Find parsers from -Parsers- based on first word in query. |
| ARCQuery.QueryExpression.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCQuery.QueryExpression.Parsers | ARCQuery | ClassMember | Parsers for all the relevant sub classes of -QueryExpression-. |
| ARCQuery.QueryExpressionWithSuggestions | ARCQuery | Class | Keeps track as each query item gets executed. |
| ARCQuery.QueryExpressionWithSuggestions.Previous | ARCQuery | ClassMember | Suggestion for a 'browse backwards' button. |
| ARCQuery.QueryExpressionWithSuggestions.Next | ARCQuery | ClassMember | Suggestion for a 'browse forwards' button. |
| ARCQuery.QueryExpressionAggregate | ARCQuery | Class | Aggregates over the given key. |
| ARCQuery.QueryExpressionAggregate.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCQuery.QueryExpressionAggregate.IsSuitableAggregator | ARCQuery | ClassMember | Returns true if |
| ARCQuery.QueryExpressionAggregate.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCQuery.QueryExpressionAggregate.SyntaxHelp | ARCQuery | ClassMember | 1) 'AGGREGATE {rowKey}' like "AGGREGATE Product" |
| ARCQuery.QueryExpressionAggregate.AggregationType | ARCQuery | ClassMember | Most common value is -Count-, in which case -AggregationKey- may be correspondingly set to null. |
| ARCQuery.QueryExpressionAggregate.AggregationKey | ARCQuery | ClassMember | This is often null (with -AggregationType- correspondingly set to Count-). |
| ARCQuery.QueryExpressionAll | ARCQuery | Class | Represents all entities for a given collection. |
| ARCQuery.QueryExpressionAll.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCQuery.QueryExpressionAll.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCQuery.QueryExpressionAll.SyntaxHelp | ARCQuery | ClassMember | 'ALL' (literally). |
| ARCQuery.QueryExpressionCache | ARCQuery | Class | Describes if cache is to be used or not. |
| ARCQuery.QueryExpressionCache.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCQuery.QueryExpressionCache.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCQuery.QueryExpressionCache.SyntaxHelp | ARCQuery | ClassMember | CACHE {ON|OFF} |
| ARCQuery.QueryExpressionHint | ARCQuery | Class | Describes if hints are to be generated (as query progresses) for potential new queries. |
| ARCQuery.QueryProgress.AdditionalJavascriptUrlEncoder | ARCQuery | ClassMember | Returns the Javascript code for converting characters that are difficult to pass in URLs to a format understood by -Decode-. |
| ARCQuery.UtilQuery | ARCQuery | Class | Utility methods for -ARCQuery-. |
| ARCQuery.UtilQuery.IndexOfOutsideOf | ARCQuery | ClassMember | Equivalent to string.IndexOf except that any character encountered inside pairs of the 'outsideOf'-char are not counted. |
| ARCQuery.UtilQuery.IndexOfAnyOutsideOf | ARCQuery | ClassMember | Equivalent to string.IndexOfAny except that any character encountered inside pairs of the 'outsideOf'-char are not counted. |
| ARCQuery.UtilQuery.SplitOutsideOf | ARCQuery | ClassMember | Equivalent to string.Split except that any character encountered inside pairs of the 'outsideOf'-char are not counted as separators. |
| ARCQuery.UtilQuery.SpecialLinkPrefixes | ARCQuery | ClassMember | Contains prefixes for which links (see -LinkInsertionInDocumentation-) are also desired without the prefix. |
| ARCQuery.ValueComparer | ARCQuery | Class | Can evaluation expressions like 'WHERE Created = ThisYear. |
| ARCQuery.ValueComparer.TryGetPrevious | ARCQuery | ClassMember | Suggestion for previous query (browsing 'backwards') |
| ARCQuery.ValueComparer.TryGetNext | ARCQuery | ClassMember | Suggestion for next query (browsing 'forwards') |
| ARCQuery.ValueComparerDateTime | ARCQuery | Class | -ValueComparerDateTime- is an attempt at offering a human language interface for date and time queries. |
| ARCQuery.ValueComparerDateTime.TryGetPrevious | ARCQuery | ClassMember | Suggestion for previous query (browsing 'backwards') |
| ARCQuery.ValueComparerDateTime.TryGetNext | ARCQuery | ClassMember | Suggestion for next query (browsing 'forwards') |
| 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+ForeignKeySingleStep | ARCQuery | Class | |
| ARCQuery.ForeignKey+ForeignKeySingleStep.ForeignType | ARCQuery | ClassMember | The foreign type. |
| ARCQuery.ForeignKey+ForeignKeySingleStep.ActualForeignKey | ARCQuery | ClassMember | The actual foreign key like OrderId or CustomerId to use for this step |
| ARCQuery.ForeignKey+ForeignKeySingleStep.ForeignEntities | ARCQuery | ClassMember | The collection containing all the (foreign) entities for the type that this step leads to |
| ARCQuery.ForeignKeyDirection | ARCQuery | Enum | Describes the type of traversing to a foreign entity possible. |
| ARCQuery.ForeignKeyDirection.ToOne | ARCQuery | EnumMember | Traverse to one entity, like traversing from OrderLine to Order (based on OrderLine containing foreign key OrderId) or Order to Customer (based on Order containing foreign key CustomerId). |
| ARCQuery.ForeignKeyDirection.ToMany | ARCQuery | EnumMember | Traverse to many entities, like traversing from Customer to Order (based on Order containing foreign key CustomerId) or Order to OrderLine (based on OrderLine containing foreign key OrderId). |
| ARCQuery.AggregationType | ARCQuery | Enum | Used by -QueryExpressionPivot- and -QueryExpressionAggregate-. |
| 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. |
| ARCQuery.QueryExpressionStrict | ARCQuery | Class | Describes -Strictness- ON / OFF when executing query. |
| ARCQuery.QueryExpressionStrict.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCQuery.QueryExpressionStrict.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCQuery.QueryExpressionStrict.SyntaxHelp | ARCQuery | ClassMember | STRICT {strictnessLevel} |
| ARCQuery.QueryExpressionTake | ARCQuery | Class | Takes a specific number of elements from the current query result. |
| ARCQuery.QueryExpressionTake.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCQuery.QueryExpressionTake.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCQuery.QueryExpressionTake.SyntaxHelp | ARCQuery | ClassMember | TAKE {Count} |
| ARCQuery.QueryExpressionWhere | ARCQuery | Class | Executes a 'WHERE {key} {operator} {value}' against the given collection. |
| ARCQuery.QueryExpressionWhere.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCQuery.QueryExpressionWhere.IsMatch | ARCQuery | ClassMember | Returns TRUE if property matches criteria. |
| ARCQuery.QueryExpressionWhere.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCQuery.QueryExpressionWhere.SyntaxHelp | ARCQuery | ClassMember | WHERE {key} {operator} {value} |
| ARCQuery.QueryExpressionWhere.Value | ARCQuery | ClassMember | The Value should ideally be as strongly typed as possible. Note that it may be of type -ValueEnum- relevant for queries like WHERE Name = NULL. |
| ARCQuery.QueryProgress | ARCQuery | Class | Keeps track of execution of query (that is, a query consisting of multiple -QueryExpression-), and also stores final result. |
| ARCQuery.QueryProgress.ToJSONSerializeable | ARCQuery | ClassMember | Override of default interface method -ToJSONSerializeable- is necessary because resulting data is 'hidden' within -Result-. |
| ARCQuery.QueryProgress.PreviousQueryJustExecuted | ARCQuery | ClassMember | TODO: This is somewhat loosely associated. |
| ARCQuery.QueryProgress.NextQueryToExecute | ARCQuery | ClassMember | TODO: This is somewhat loosely associated. |
| ARCQuery.QueryProgress.ToHTMLSimpleSingle | ARCQuery | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCQuery.QueryProgress.OrderAndReconstructKeys | ARCQuery | ClassMember | Part 1: |
| ARCQuery.QueryProgress.GetHTMLLinksToIndividualQueryParts | ARCQuery | ClassMember | Is able to generate the following: |
| ARCQuery.QueryProgress.ToString | ARCQuery | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.QueryProgress.Result | ARCQuery | ClassMember | This gets updated continously as the different query expressions get evaluated. |
| ARCQuery.QueryProgress.ExecutedQueries | ARCQuery | ClassMember | The result from calling -Execute- for each query in -Queries-. |
| ARCQuery.QueryProgressP | ARCQuery | Enum | Describes class -QueryProgress-. |
| ARCQuery.QueryProgressP.Queries | ARCQuery | EnumMember | |
| ARCQuery.QueryProgressP.StrCurrentType | ARCQuery | EnumMember | Normally the -ToStringVeryShort- representation of the type of objects in the -Result- collection. |
| ARCQuery.QueryProgressP.CurrentStrictness | ARCQuery | EnumMember | Describes -Strictness- ON / OFF when executing query. |
| ARCQuery.QueryProgressP.CreateHints | ARCQuery | EnumMember | Describes if hints are to be generated (as query progresses) for new queries. |
| ARCQuery.QueryProgressP.UseCache | ARCQuery | EnumMember | Describes if cache is to be used or not. |
| ARCQuery.QueryProgressP.Limit | ARCQuery | EnumMember | Limits the final HTML presentation of results (limits the number of elements being presented). Does not affect the query in itself. Used in order to avoid building huge HTML pages which will not be consumed anyway. |
| ARCQuery.QueryProgressP.TerminateReason | ARCQuery | EnumMember | The reason for a query being terminated. This property should contain a user friendly message about the problem and how to fix it. |
| ARCQuery.QueryProgressP.AllLogEntriesForThisQuery | ARCQuery | EnumMember | |
| ARCQuery.EntityMethodKey+MethodType | ARCQuery | Enum | Explains type of method signature found (trough reflection) for corresponding entity class. |
| ARCQuery.EntityMethodKey+MethodType.Simple | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)' |
| ARCQuery.EntityMethodKey+MethodType.Complex | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)' |
| ARCQuery.QueryExpressionWhere+ValueEnum | ARCQuery | Enum | Helper enum used internally by -QueryExpressionWhere- in order to represent queries like WHERE Name = NULL, WHERE Name = NOTNULL and WHERE Name = * (ALL). |
| ARCQuery.QueryExpressionWhere+ValueEnum.NULL | ARCQuery | EnumMember | |
| ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULL | ARCQuery | EnumMember | Practical value enabling suggestions from -GetPrevious- and -GetNext-. |
Generated 2025-11-26 10:45:08.535 UTC