[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 1019 > < TAKE 992 >
158 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). |
| ARCQuery.QueryProgress | ARCQuery | Class | Keeps track of execution of query (that is, a query consisting of multiple -QueryExpression-), and also stores final result. |
| ARCQuery.QueryExpression.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCAPI.BaseController.GetTimestampIsOldWarningHTML | ARCAPI | ClassMember | If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format. |
| ARCQuery.QueryProgressP.Title | ARCQuery | EnumMember | The title to be used in the final presentation of the query result. |
| ARCQuery.QueryProgress.ToJSONSerializeable | ARCQuery | ClassMember | Override of default interface method -ToJSONSerializeable- is necessary because resulting data is 'hidden' within -Result-. |
| ARCQuery.QueryExpression.Parsers | ARCQuery | ClassMember | Parsers for all the relevant sub classes of -QueryExpression-. |
| ARCAPI.BaseController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.QueryProgressP.Queries | ARCQuery | EnumMember | |
| ARCQuery.QueryProgress.PreviousQueryJustExecuted | ARCQuery | ClassMember | TODO: This is somewhat loosely associated. |
| ARCQuery.QueryExpressionWithSuggestions | ARCQuery | Class | Keeps track as each query item gets executed. |
| ARCAPI.EditController | ARCAPI | Class | Offers a simple HTML editing environment of the raw -PropertyStream- from the given key. |
| ARCQuery.QueryProgressP.StrCurrentType | ARCQuery | EnumMember | Normally the -ToStringVeryShort- representation of the type of objects in the -Result- collection. |
| ARCQuery.QueryProgress.NextQueryToExecute | ARCQuery | ClassMember | TODO: This is somewhat loosely associated. |
| ARCQuery.QueryExpressionWithSuggestions.Previous | ARCQuery | ClassMember | Suggestion for a 'browse backwards' button. |
| ARCAPI.EditController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCQuery.QueryProgressP.CurrentStrictness | ARCQuery | EnumMember | Describes -Strictness- ON / OFF when executing query. |
| ARCQuery.QueryProgress.ToHTMLSimpleSingle | ARCQuery | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCQuery.QueryExpressionWithSuggestions.Next | ARCQuery | ClassMember | Suggestion for a 'browse forwards' button. |
| ARCAPI.EditController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.QueryProgressP.CreateHints | ARCQuery | EnumMember | Describes if hints are to be generated (as query progresses) for new queries. |
| ARCQuery.QueryProgress.OrderAndReconstructKeys | ARCQuery | ClassMember | Part 1: |
| ARCQuery.QueryExpressionAggregate | ARCQuery | Class | Aggregates over the given key. |
| ARCAPI.GQController | ARCAPI | Class | Offers GraphQL queries. |
| ARCQuery.QueryProgressP.UseCache | ARCQuery | EnumMember | Describes if cache is to be used or not. |
| ARCQuery.QueryProgress.GetHTMLLinksToIndividualQueryParts | ARCQuery | ClassMember | Is able to generate the following: |
| ARCQuery.QueryExpressionAggregate.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCAPI.GQController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCQuery.QueryProgressP.LinkAdjustment | ARCQuery | EnumMember | Experimental: Adjustment to be done by -QueryProgress-.- ToHTMLSimpleSingle- (when it ascertains how to go back to root level). |
| ARCQuery.QueryProgress.ToString | ARCQuery | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.QueryExpressionAggregate.IsSuitableAggregator | ARCQuery | ClassMember | Returns true if |
| ARCAPI.GQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| 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.QueryProgress.DataStorage | ARCQuery | ClassMember | Note how this property will point to the hierarhical level in the data storage from which the first -QueryExpression- was found in the query string. |
| ARCQuery.QueryExpressionAggregate.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCAPI.RQController | ARCAPI | Class | RQ = REST Query. Executes a REST like query request against the given -DataStorage-. |
| 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.QueryProgress.Result | ARCQuery | ClassMember | This gets updated continously as the different query expressions get evaluated. |
| ARCQuery.QueryExpressionAggregate.SyntaxHelp | ARCQuery | ClassMember | 1) 'AGGREGATE {rowKey}' like "AGGREGATE Product" |
| ARCAPI.RQController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCQuery.QueryProgressP.AllLogEntriesForThisQuery | ARCQuery | EnumMember | |
| ARCQuery.QueryProgress.ExecutedQueries | ARCQuery | ClassMember | The result from calling -Execute- for each query in -Queries-. |
| ARCQuery.QueryExpressionAggregate.AggregationType | ARCQuery | ClassMember | Most common value is -Count-, in which case -AggregationKey- may be correspondingly set to null. |
| ARCAPI.RQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.TranslationsP | ARCQuery | Enum | This enum has no values because the keys are the actual string to be translated. |
| 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.QueryExpressionAggregate.AggregationKey | ARCQuery | ClassMember | This is often null (with -AggregationType- correspondingly set to Count-). |
| ARCAPI.DataStorage | ARCAPI | Class | The all-in-memory global application data storage. |
| ARCQuery.TranslationSingleP | ARCQuery | Enum | Describes class -TranslationSingle-. |
| ARCQuery.Translations | ARCQuery | Class | Offers a very simple system for keeping track of translation between different ("western") languages. |
| ARCQuery.QueryExpressionAll | ARCQuery | Class | Represents all entities for a given collection. |
| ARCAPI.DataStorage.Create | ARCAPI | ClassMember | Creates a -DataStorage- instance with default parameters. |
| ARCQuery.TranslationSingleP.Text | ARCQuery | EnumMember | |
| ARCQuery.Translations.ToString | ARCQuery | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.QueryExpressionAll.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCAPI.DataStorage..ctor | ARCAPI | ClassMember | This method will: |
| ARCQuery.TranslationSingleP.IsMissing | ARCQuery | EnumMember | Value TRUE indicates that the Text given is simply the original key, in other words, the translation for the key is actually missing. |
| ARCQuery.TranslationsCollection | ARCQuery | Class | This would consist of one key per language, with keys like "de_DE", "fr_FR", "nb_NO". |
| ARCQuery.QueryExpressionAll.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCAPI.DataStorage.Storage | ARCAPI | ClassMember | The actual storage. |
| ARCQuery.EntityMethodKey+MethodType | ARCQuery | Enum | Explains type of method signature found (trough reflection) for corresponding entity class. |
| ARCQuery.TranslationsCollection.TrySetPP | ARCQuery | ClassMember | Replaces default interface method -TrySetPP-. |
| ARCQuery.QueryExpressionAll.SyntaxHelp | ARCQuery | ClassMember | 'ALL' (literally). |
| ARCAPI.DataStorage.ControllerStorage | ARCAPI | ClassMember | Usually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]). |
| ARCQuery.EntityMethodKey+MethodType.Simple | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)' |
| ARCQuery.TranslationsCollection.GetKeysEqualToValue | ARCQuery | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
| ARCQuery.QueryExpressionCache | ARCQuery | Class | Describes if cache is to be used or not. |
| ARCAPI.DataStorage.DocLinks | ARCAPI | ClassMember | Note that may be null. |
| ARCQuery.EntityMethodKey+MethodType.Complex | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)' |
| ARCQuery.TranslationsCollection.TryGetP | ARCQuery | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
| ARCQuery.QueryExpressionCache.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCAPI.DataStorage.Lock | ARCAPI | ClassMember | Locking object for thread-safe access from simultaneous API requests. |
| ARCQuery.QueryExpressionWhere+WildcardPositionType | ARCQuery | Enum | Position of wildcard in value, like '*ABC' (-AtStart-), 'ABC*' (-AtEnd-) and |
| ARCQuery.TranslationsCollection.TryGetV | ARCQuery | 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). |
| ARCQuery.QueryExpressionCache.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCAPI.DataStorage.ExternalReceiver | ARCAPI | ClassMember | Typically used by -AddController-. |
| ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStart | ARCQuery | EnumMember | Example: '*ABC'. |
| ARCQuery.TranslationsCollection.ToString | ARCQuery | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.QueryExpressionCache.SyntaxHelp | ARCQuery | ClassMember | CACHE {ON|OFF} |
| ARCAPI.DataStorage.DoNotStoreInternally | ARCAPI | ClassMember | Typically used by -AddController-. |
| ARCQuery.QueryExpressionWhere+WildcardPositionType.AtEnd | ARCQuery | EnumMember | Example: 'ABC*'. |
| ARCQuery.TranslationSingle | ARCQuery | Class | Describes a single translation. |
| ARCQuery.QueryExpressionComment | ARCQuery | Class | Allows insertion of SQL style comments (beginning with double hyphens / minus signs, '--') into queries. |
| ARCAPI.BaseControllerP | ARCAPI | Enum | Describes class -BaseController-. |
| ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStartAndEnd | ARCQuery | EnumMember | Example: '*ABC*'. |
| ARCQuery.TranslationSingle.TryGetReferenceCount | ARCQuery | ClassMember | Method signature understood by -TryGetP- / -EntityMethodKey-. |
| ARCQuery.QueryExpressionComment.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCAPI.BaseControllerP.CountRequest | ARCAPI | EnumMember | Number of calls to -APIMethod- since application initialization |
| 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.TranslationSingle.TryGetPS | ARCQuery | ClassMember | Returns a -PropertyStreamLine- representation of this translation. |
| ARCQuery.QueryExpressionComment.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCAPI.BaseControllerP.CountException | ARCAPI | EnumMember | Number of exceptions at call to -APIMethod- since application initialization |
| ARCQuery.QueryExpressionWhere+ValueEnum.NULL | ARCQuery | EnumMember | |
| ARCQuery.TranslationSingle.TryGetA | ARCQuery | ClassMember | Returns a -PropertyStreamLine- representation of this translation. |
| ARCQuery.QueryExpressionComment.SyntaxHelp | ARCQuery | ClassMember | COMMENT {comment text} |
| ARCAPI.BaseControllerP.LogLevel | ARCAPI | EnumMember | |
| ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULL | ARCQuery | EnumMember | Practical value enabling suggestions from -GetPrevious- and -GetNext-. |
| ARCAPI.ResponseFormat | ARCAPI | Enum | The response format, HTML or JSON, for an API request. |
| ARCQuery.ValueComparerDateTime.TryParse | ARCQuery | ClassMember | Note: This parser is probably exhaustive but not necessarily logical |
| ARCAPI.ResponseFormat.JSON | ARCAPI | EnumMember | |
| ARCQuery.ValueComparerDateTime.Resolution | ARCQuery | ClassMember | See -ResolutionEnum-. |
| ARCAPI.ResponseFormat.HTML | ARCAPI | EnumMember | |
| ARCQuery.ValueComparerDateTime.Steps | ARCQuery | ClassMember | Value 0 would mean 'This', like ThisHour, Today, ThisMonth and so on. |
| Assembly AgoBrowse | Assembly | ||
| ARCQuery.ValueComparerDateTime.IsGliding | ARCQuery | ClassMember | The modifier 'Gliding' (or just 'G') can be appended in order to mean continous gliding periode, so for instance |
| AgoBrowse.Program | AgoBrowse | Class | |
| ARCQuery.ValueComparerDateTime.IsBefore | ARCQuery | ClassMember | The modifier 'Before' can be prepended in order to mean from any time before the specified time. |
| AgoBrowse.Program.InitStreamProcessor | AgoBrowse | ClassMember | Initializes stream processor. |
| ARCQuery.ValueComparerDateTime.IsAfter | ARCQuery | ClassMember | The modifier 'After' can be prepended in order to mean any time after the specified time. |
| AgoBrowse.Root | AgoBrowse | Class | Contains the user friendly welcome text (front page) for the application. |
| ARCQuery.ValueComparerDateTime.IsInterval | ARCQuery | ClassMember | Normally the interval which is compared against is the timespan corresponding to -Resolution-. |
| AgoBrowse.Root.ToHTMLSimpleSingle | AgoBrowse | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCQuery.ValueComparerDateTime.InitValue | ARCQuery | ClassMember | For debugging purposes. The initial 'now' value used before calculating -StartPeriod- and -EndPeriod-. |
| AgoBrowse.Root.TryGetP | AgoBrowse | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
| ARCQuery.ValueComparerDateTime.StartPeriod | ARCQuery | ClassMember | The start of the interval which this instance compares against. |
| AgoBrowse.Root.TryGetV | AgoBrowse | 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). |
| ARCQuery.ValueComparerDateTime.EndPeriod | ARCQuery | ClassMember | The end of the interval which this instance compares against. |
| AgoBrowse.Root.ToString | AgoBrowse | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.ValueComparerDateTime.ToDebugProperties | ARCQuery | ClassMember | Exposes all members of this class. |
| AgoBrowse.Controllers.CompileController | AgoBrowse | Class | Compiles a hierarchical 'picture book' from the requested position in the -DataStorage-. |
| ARCQuery.ForeignKey+IKIPEqualityComparer | ARCQuery | Class | Used by -TryGetPInternal- when it needs distinct list of foreign entities, based on their keys |
| AgoBrowse.Controllers.CompileController.APIMethod | AgoBrowse | ClassMember | The (only) API method that this controller supports. |
| ARCQuery.ForeignKey+EntityTypeAndKey | ARCQuery | Class | Describes an entity type and a key. |
| AgoBrowse.Controllers.CompileController.Compile | AgoBrowse | ClassMember | Compiles a hierarchical 'picture book' from the given parameter. |
| ARCQuery.ForeignKey+EntityTypeAndKey.EntityType | ARCQuery | ClassMember | For -IPRelationsKeysPointingTo-, corresponds to foreign entity type. |
| AgoBrowse.Controllers.CompileController.ToString | AgoBrowse | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| 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. |
| AgoBrowse.Controllers.ControllerFacade | AgoBrowse | Class | Facade for entry into the desired -RQController-. |
| ARCQuery.ForeignKey+EntityTypeAndKey.OppositeTerm | ARCQuery | ClassMember | Corresponds to -PKRelAttributeP-.- OppositeTerm-. |
| AgoBrowse.Controllers.ControllerFacade.CatchAll Overload2 | AgoBrowse | ClassMember | Catches all HTTP GET requests to this API. |
| ARCQuery.ForeignKey+ForeignKeySingleStep | ARCQuery | Class | Describes how to traverse between related entities. |
| AgoBrowse.Controllers.ControllerFacade.CatchAll Overload1 | AgoBrowse | ClassMember | Catches all HTTP POST requests to this API. |
| ARCQuery.ForeignKey+ForeignKeySingleStep.ForeignEntitiesCollection | ARCQuery | ClassMember | The collection containing all the (foreign) entities for the type that this step leads to |
| Namespace ARCCore | Namespace | A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to. | |
| ARCQuery.QueryExpressionSelfCreate+ISelfCreateCollection | ARCQuery | Class | Provides a standardized mechanism for describing classes that are able to autogenerate collection of themeselves. |
| Namespace ARCDoc | Namespace | A library supporting documentation and demonstrating usage of AgoRapide. | |
| ARCQuery.ForeignKeyDirection | ARCQuery | Enum | Describes the type of traversing to a foreign entity possible. |
| Namespace ARCQuery | Namespace | ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs. | |
| 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). |
| Namespace ARCAPI | Namespace | A library providing an API on top of the -PropertyStream-. | |
| 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). |
| Namespace AgoBrowse | Namespace | ||
| ARCQuery.AggregationType | ARCQuery | Enum | Used by -QueryExpressionPivot- and -QueryExpressionAggregate-. |
| Namespace AgoBrowse.Controllers | Namespace | ||
| ARCQuery.AggregationType.Count | ARCQuery | EnumMember | |
| ARCQuery.AggregationType.Sum | ARCQuery | EnumMember | |
| ARCQuery.RelationalOperator | ARCQuery | Enum | Relational / comparision operators. |
| ARCQuery.RelationalOperator.EQ | ARCQuery | EnumMember | |
| ARCQuery.RelationalOperator.CONTAINS | ARCQuery | EnumMember | |
| ARCQuery.RelationalOperator.NEQ | ARCQuery | EnumMember | |
| ARCQuery.RelationalOperator.NOTCONTAINS | ARCQuery | EnumMember | |
| ARCQuery.RelationalOperator.GT | ARCQuery | EnumMember | |
| ARCQuery.RelationalOperator.LT | ARCQuery | EnumMember |
Generated 2025-10-02 15:35:54.187 UTC