[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 1014 > < TAKE 124 >
124 items
DocFragId | Assembly | DocFragType | Description.FirstLine() |
---|---|---|---|
ARCAPI.BaseController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
ARCQuery.Quantile.VENTILE | ARCQuery | EnumMember | Divide into 20 parts |
ARCQuery.QueryExpressionWhere.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCAPI.BaseController.CatchAll | ARCAPI | ClassMember | Serves the typical single generic API method in an AgoRapide API. |
ARCQuery.Quantile.PERCENTILE | ARCQuery | EnumMember | Divide into 100 parts |
ARCQuery.QueryExpressionWhere.SyntaxHelp | ARCQuery | ClassMember | WHERE {key} {operator} {value} |
ARCAPI.BaseController.TryNavigateToLevelInDataStorage | ARCAPI | ClassMember | Navigates to the specified level (usually within -Storage-). |
ARCQuery.Quantile.PERMILLE | ARCQuery | EnumMember | Divide into 1000 parts |
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. |
ARCAPI.BaseController.GetFormatAndAdjustRequest | ARCAPI | ClassMember | Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on). |
ARCQuery.QueryProgressP | ARCQuery | Enum | Describes class -QueryProgress-. |
ARCQuery.QueryProgress | ARCQuery | Class | Keeps track of execution of query (that is, a query consisting of multiple -QueryExpression-), and also stores final result. |
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.QueryProgressP.Queries | ARCQuery | EnumMember | |
ARCQuery.QueryProgress.PreviousQueryJustExecuted | ARCQuery | ClassMember | TODO: This is somewhat loosely associated. |
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.QueryProgressP.CurrentStrictness | ARCQuery | EnumMember | Describes -Strictness- ON / OFF when executing query. |
ARCQuery.QueryProgress.ToHTMLSimpleSingle | ARCQuery | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
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.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.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.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.ForeignKey+ForeignKeySingleStep | ARCQuery | Class | Describes how to traverse between related entities. |
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.ForeignKey+ForeignKeySingleStep.ForeignEntitiesCollection | ARCQuery | ClassMember | The collection containing all the (foreign) entities for the type that this step leads to |
ARCQuery.QueryProgressP.AllLogEntriesForThisQuery | ARCQuery | EnumMember | |
ARCQuery.QueryExpressionSelfCreate+ISelfCreateCollection | ARCQuery | Class | Provides a standardized mechanism for describing classes that are able to autogenerate collection of themeselves. |
ARCQuery.TranslationsP | ARCQuery | Enum | This enum has no values because the keys are the actual string to be translated. |
ARCQuery.ForeignKeyDirection | ARCQuery | Enum | Describes the type of traversing to a foreign entity possible. |
ARCQuery.TranslationSingleP | ARCQuery | Enum | Describes class -TranslationSingle-. |
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.TranslationSingleP.Text | ARCQuery | EnumMember | |
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.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.AggregationType | ARCQuery | Enum | Used by -QueryExpressionPivot- and -QueryExpressionAggregate-. |
ARCQuery.EntityMethodKey+MethodType | ARCQuery | Enum | Explains type of method signature found (trough reflection) for corresponding entity class. |
ARCQuery.AggregationType.Count | ARCQuery | EnumMember | |
ARCQuery.EntityMethodKey+MethodType.Simple | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)' |
ARCQuery.AggregationType.Sum | ARCQuery | EnumMember | |
ARCQuery.EntityMethodKey+MethodType.Complex | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)' |
ARCQuery.RelationalOperator | ARCQuery | Enum | Relational / comparision operators. |
ARCQuery.QueryExpressionWhere+WildcardPositionType | ARCQuery | Enum | Position of wildcard in value, like '*ABC' (-AtStart-), 'ABC*' (-AtEnd-) and |
ARCQuery.RelationalOperator.EQ | ARCQuery | EnumMember | |
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStart | ARCQuery | EnumMember | Example: '*ABC'. |
ARCQuery.RelationalOperator.CONTAINS | ARCQuery | EnumMember | |
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtEnd | ARCQuery | EnumMember | Example: 'ABC*'. |
ARCQuery.RelationalOperator.NEQ | ARCQuery | EnumMember | |
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStartAndEnd | ARCQuery | EnumMember | Example: '*ABC*'. |
ARCQuery.RelationalOperator.NOTCONTAINS | ARCQuery | EnumMember | |
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.RelationalOperator.GT | ARCQuery | EnumMember | |
ARCQuery.QueryExpressionWhere+ValueEnum.NULL | ARCQuery | EnumMember | |
ARCQuery.RelationalOperator.LT | ARCQuery | EnumMember | |
ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULL | ARCQuery | EnumMember | Practical value enabling suggestions from -GetPrevious- and -GetNext-. |
ARCQuery.RelationalOperator.GEQ | ARCQuery | EnumMember | |
ARCQuery.RelationalOperator.LEQ | ARCQuery | EnumMember | |
ARCQuery.RelationalOperator.LIKE | ARCQuery | EnumMember | Case sensitive string wildcard comparision. |
ARCQuery.RelationalOperator.ILIKE | ARCQuery | EnumMember | Case insensitive string wildcard comparision. |
ARCQuery.RelationalOperator.NOTLIKE | ARCQuery | EnumMember | Case sensitive string wildcard comparision. |
ARCQuery.RelationalOperator.NOTILIKE | ARCQuery | EnumMember | Case insensitive string wildcard comparision. |
ARCQuery.Strictness | ARCQuery | Enum | Describes level of -Strictness- when executing query. |
ARCQuery.Strictness.ON | ARCQuery | EnumMember | |
ARCQuery.Strictness.OFF | ARCQuery | EnumMember | |
ARCQuery.Quantile | ARCQuery | Enum | Describes quantiles like -TERTILE- and -QUARTILE-. |
ARCQuery.Quantile.MEDIAN | ARCQuery | EnumMember | Divide into two parts |
ARCQuery.Quantile.TERTILE | ARCQuery | EnumMember | Divide into three parts |
ARCQuery.Quantile.QUARTILE | ARCQuery | EnumMember | Divide into four parts |
ARCQuery.Quantile.QUINTILE | ARCQuery | EnumMember | Divide into five parts |
ARCQuery.Quantile.SEXTILE | ARCQuery | EnumMember | Divide into 6 parts |
ARCQuery.Quantile.SEPTILE | ARCQuery | EnumMember | Divide into 7 parts |
ARCQuery.QueryExpressionWhere+ValueEnum.ALL | ARCQuery | EnumMember | Equivalent to query like WHERE Name = * |
ARCQuery.ValueComparerDateTime+ResolutionEnum | ARCQuery | Enum | |
ARCQuery.ValueComparerDateTime+ResolutionEnum.Second | ARCQuery | EnumMember | |
ARCQuery.ValueComparerDateTime+ResolutionEnum.Minute | ARCQuery | EnumMember | |
ARCQuery.ValueComparerDateTime+ResolutionEnum.Hour | ARCQuery | EnumMember | |
ARCQuery.ValueComparerDateTime+ResolutionEnum.Day | ARCQuery | EnumMember | |
ARCQuery.ValueComparerDateTime+ResolutionEnum.Week | ARCQuery | EnumMember | |
ARCQuery.ValueComparerDateTime+ResolutionEnum.Month | ARCQuery | EnumMember | |
ARCQuery.ValueComparerDateTime+ResolutionEnum.Quarter | ARCQuery | EnumMember | |
ARCQuery.ValueComparerDateTime+ResolutionEnum.Year | ARCQuery | EnumMember | |
Assembly ARCAPI | Assembly | A library providing an API on top of the -PropertyStream-. | |
ARCAPI.ContentResult | ARCAPI | Class | Mimicks Microsoft.AspNetCore.Mvc.ContentResult. |
ARCAPI.ContentResult.CreateHTMLOK | ARCAPI | ClassMember | NOTE: Parameter must be a complete HTML page. |
ARCAPI.ContentResult.CreateError | ARCAPI | ClassMember | TODO: Add a key / value format for error messages, like done for -Log-. |
ARCAPI.AddController | ARCAPI | Class | Parses and stores a -PropertyStreamLine-. |
ARCAPI.AddController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
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 AgoBrowse | Assembly | ||
AgoBrowse.Program | AgoBrowse | Class | |
AgoBrowse.Program.InitStreamProcessor | AgoBrowse | ClassMember | Initializes stream processor. |
AgoBrowse.Root | AgoBrowse | Class | Contains the user friendly welcome text (front page) for the application. |
AgoBrowse.Root.ToHTMLSimpleSingle | AgoBrowse | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
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. |
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). |
AgoBrowse.Root.ToString | AgoBrowse | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
AgoBrowse.Controllers.CompileController | AgoBrowse | Class | Compiles a hierarchical 'picture book' from the requested position in the -DataStorage-. |
AgoBrowse.Controllers.CompileController.APIMethod | AgoBrowse | ClassMember | The (only) API method that this controller supports. |
AgoBrowse.Controllers.CompileController.Compile | AgoBrowse | ClassMember | Compiles a hierarchical 'picture book' from the given parameter. |
AgoBrowse.Controllers.CompileController.ToString | AgoBrowse | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
AgoBrowse.Controllers.ControllerFacade | AgoBrowse | Class | Facade for entry into the desired -RQController-. |
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload2 | AgoBrowse | ClassMember | Catches all HTTP GET requests to this API. |
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload1 | AgoBrowse | ClassMember | Catches all HTTP POST requests to this API. |
Namespace ARCCore | Namespace | A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to. | |
Namespace ARCDoc | Namespace | A library supporting documentation and demonstrating usage of AgoRapide. | |
Namespace ARCQuery | Namespace | ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs. | |
Namespace ARCAPI | Namespace | A library providing an API on top of the -PropertyStream-. | |
Namespace AgoBrowse | Namespace | ||
Namespace AgoBrowse.Controllers | Namespace | ||
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-. |
Generated 2025-06-22 07:34:36.704 UTC