[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 1048 > < TAKE 496 >
129 items
DocFragId | Assembly | DocFragType | Description.FirstLine() |
---|---|---|---|
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.AddController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCAPI.AddController.AllowFilter | ARCAPI | ClassMember | Describes what data is allowed to change through a list of -Subscription- instances. |
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.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-. |
ARCQuery.QueryExpressionComment | ARCQuery | Class | Allows insertion of SQL style comments (beginning with double hyphens / minus signs, '--') into queries. |
ARCQuery.QueryExpressionComment.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCQuery.QueryExpressionComment.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionComment.SyntaxHelp | ARCQuery | ClassMember | COMMENT {comment text} |
ARCQuery.QueryExpressionDataStorage | ARCQuery | Class | Experimental as of Mar 2022: Resets value for -DataStorage- |
ARCQuery.QueryExpressionDataStorage.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCQuery.QueryExpressionDataStorage.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionDataStorage.SyntaxHelp | ARCQuery | ClassMember | DATASTORAGE {new hierarchical level} [link adjustment] |
ARCQuery.QueryExpressionDataStorage.LinkAdjustment | ARCQuery | ClassMember | See -LinkAdjustment- for documentation. |
ARCQuery.QueryExpressionDataStorage.GlobalDataStorage | ARCQuery | ClassMember | TODO: Find some better initialization here. |
ARCQuery.QueryExpressionHint | ARCQuery | Class | Describes if hints are to be generated (as query progresses) for potential new queries. |
ARCQuery.QueryExpressionHint.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCQuery.QueryExpressionHint.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionHint.SyntaxHelp | ARCQuery | ClassMember | HINT {ON|OFF} |
ARCQuery.QueryExpressionLimit | ARCQuery | Class | Limits the final HTML presentation of results (limits the number of elements being presented). |
ARCQuery.QueryExpressionLimit.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCQuery.QueryExpressionLimit.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionLimit.SyntaxHelp | ARCQuery | ClassMember | Syntax: LIMIT {limit} like 'LIMIT 42' |
ARCQuery.QueryExpressionLog | ARCQuery | Class | A debugging tool used to extract detailed log information about the execution of the query. |
ARCQuery.QueryExpressionLog.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
ARCQuery.QueryExpressionLog.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionLog.SyntaxHelp | ARCQuery | ClassMember | 'Log'. |
ARCQuery.QueryExpressionOrderBy | ARCQuery | Class | Orders collection. |
ARCQuery.QueryExpressionOrderBy.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
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-. |
ARCQuery.ForeignKey+ForeignKeySingleStep | ARCQuery | Class | Describes how to traverse between related entities. |
ARCQuery.ForeignKey+ForeignKeySingleStep.ForeignEntitiesCollection | ARCQuery | ClassMember | The collection containing all the (foreign) entities for the type that this step leads to |
ARCQuery.QueryExpressionSelfCreate+ISelfCreateCollection | ARCQuery | Class | Provides a standardized mechanism for describing classes that are able to autogenerate collection of themeselves. |
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-. |
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 | |
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. |
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 | |
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 | ||
ARCCore.BasePKAttribute | ARCCore | Class | The class containing the actual attributes used for -TaggingOfPropertyKeys-. |
ARCCore.ClassAttribute.Initialize | ARCCore | ClassMember | To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization. |
ARCCore.ClassMemberAttribute | ARCCore | Class | Describes a member of a class (a method). |
ARCCore.ClassMemberAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
ARCCore.EnumAttribute.Initialize | ARCCore | ClassMember | To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization. |
ARCCore.EnumMemberAttribute.Initialize | ARCCore | ClassMember | To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization. |
ARCCore.EnumMemberAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
ARCCore.CardinalityExtensions | ARCCore | Class | |
ARCCore.Extensions | ARCCore | Class | Contains a few general nice to have extensions methods. |
ARCCore.Extensions.ToStringShort | ARCCore | ClassMember | Returns a shorter representation than -ToStringDB-. |
ARCCore.Extensions.KeysAsString | ARCCore | ClassMember | Gives a compressed overview of keys in a dictionary. Helpful for building exception messages. |
ARCCore.Extensions.GetValue | ARCCore | ClassMember | Gives better error messages when reading value from directory if key does not exist |
ARCCore.IKCoded | ARCCore | Class | Understands coded and unencoded variants of -IK-. |
ARCCore.IKCoded.EnrichKey | ARCCore | ClassMember | 'Implementing' -ITypeDescriber-. |
ARCCore.IKCoded.TryEncode | ARCCore | ClassMember | Returns a string containing only characters in -AllowedEncodedCharacters-. |
ARCCore.IKCoded.ToString | ARCCore | ClassMember | Returns -Encoded-'s string representation. |
ARCCore.IKLong | ARCCore | Class | A more memory efficient alternative to -IKString-. |
ARCCore.IKLong.op_Equality | ARCCore | ClassMember | It is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here. |
ARCCore.IKType | ARCCore | Class | Index key used when storing a collection of a given type, like 'Customer'. |
ARCCore.IKType.ToString | ARCCore | ClassMember | Caching is supposed to be useful because may be called quite often. |
ARCCore.PK.TryGetEnum | ARCCore | ClassMember | Note that usually you will not have to ask for this value, usually in AgoRapide it goes the other way around, you have the enum member / enum value and want the corresponding property key. |
ARCCore.PK.TryGetV | ARCCore | ClassMember | Only type of PK, string or type of __enum is allowed to ask for (as TRequest generic type parameter). |
ARCCore.PK.GetAllPKForEntityType | ARCCore | ClassMember | Returns all property keys relevant for the given entity type, |
ARCCore.PK.GetAllPKForEntityTypeString | ARCCore | ClassMember | Returns all property keys relevant for the given entity type, |
ARCCore.PK..ctor | ARCCore | ClassMember | Constructor with 'object _enum' is necessary in order for ToString to work. |
ARCCore.PK.Type | ARCCore | ClassMember | Returns type from -PKTypeAttribute-'s -Type-. |
ARCCore.PK.Cardinality | ARCCore | ClassMember | Returns cardinality from -PKTypeAttribute-'s -Cardinality-. |
ARCCore.PK.CorrespondingClass | ARCCore | ClassMember | Returns -CorrespondingClass- based on -__enum-. |
Generated 2025-08-08 21:03:46.210 UTC