[ROOT]  doc  DocFrag  SELECT Assembly, DocFragType, Description.FirstLine()   <  SKIP 73  >   <  TAKE 124  >   

124 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.PK.TryGetVARCCoreClassMemberOnly type of PK, string or type of __enum is allowed to ask for (as TRequest generic type parameter).
ARCCore.IKStringARCCoreClassIndex key for any general id, like primary-key or sequence-number or similar.
ARCCore.PKARCCoreClassPK = AgoRapide PropertyKey.
ARCCore.IKString.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.PK.GetAARCCoreClassMemberConvenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails
ARCCore.IKString.FromCacheARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.PK.TryGetEnumARCCoreClassMemberNote 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.IKTypeARCCoreClassIndex key used when storing a collection of a given type, like 'Customer'.
ARCCore.PK.PackObjectForStorageInEntityObjectARCCoreClassMemberSee -PackParseResultForStorageInEntityObject- for documentation.
ARCCore.ParseResult.ResultARCCoreClassMemberWill be null if ErrorResponse is set.
ARCCore.PK.TryCleanValidateAndParseARCCoreClassMemberCleans and parses the value according to specifications for this property key.
ARCCore.ITypeDescriber.GetSyntaxHelpARCCoreClassMemberEnables explanation of syntax in different contexts from one source:
ARCCore.PK.FromEnumARCCoreClassMemberReturns the corresponding -PK- instance from the given -PropertyKeyEnum-.
ARCCore.ParseResult.ErrorResponseARCCoreClassMemberWill be null if Result is set
ARCCore.PK.PackParseResultForStorageInEntityObjectARCCoreClassMemberPacks result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-.
ARCCore.ParseResultARCCoreClassNOTE: Concept is very old, from the dark ages of AgoRapide's very first inception. There might be room for improvement.
ARCCore.PK..ctorARCCoreClassMemberConstructor with 'object _enum' is necessary in order for ToString to work.
ARCCore.PK.TryGetAARCCoreClassMemberConvenience method for easy access to -BasePKAttribute-.
ARCCore.PK.EqualsARCCoreClassMemberNote that ToString is only based on __enum, meaning that two enum members / enum values with same name but different type, like CustomerP.Name and OrderP.Name, will be considered equal.
ARCCore.PK.ToStringARCCoreClassMemberCaching is supposed to be useful because may be called quite often.
ARCCore.PK.TypeARCCoreClassMemberReturns type from -PKTypeAttribute-'s -Type-.
ARCCore.PK.ModifyCleanerAndValidatorAndParserForCardinalityARCCoreClassMemberCalled from -Initialize- after _cleaner and _validatorAndParser have been set.
ARCCore.PK.TryGetPARCCoreClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.PK.TryValidateAndParseARCCoreClassMemberParses the value according to specifications for this property key.
ARCCore.PK.CardinalityARCCoreClassMemberReturns cardinality from -PKTypeAttribute-'s -Cardinality-.
ARCCore.PK.TryGetFromTypeAndFieldName Overload3ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.PKHTMLAttribute.EncodeARCCoreClassMemberEncodes the given string to HTML format through the static method implemented in class -Encoder-.
ARCCore.PK.GetAllPKForEntityTypeStringARCCoreClassMemberReturns all property keys relevant for the given entity type,
ARCCore.PK.CorrespondingClassARCCoreClassMemberReturns -CorrespondingClass- based on -__enum-.
ARCCore.PK.TryGetFromTypeAndFieldName Overload2ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.PKHTMLAttribute.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.PK.BuildFromStringCacheARCCoreClassMemberBuilds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-.
ARCCore.PK.ValidatorAndParserARCCoreClassMemberValidates and parses a value.
ARCCore.PK.TryGetFromTypeAndFieldName Overload1ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.PKHTMLAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.PK.GetTypeMappingARCCoreClassMemberReturns the relevant property key for a given type entity-type and field-type.
ARCCore.PK.CleanerARCCoreClassMemberCleanup of values, to be used before value is attempted validated.
ARCCore.PK.GetAllPKForEntityTypeARCCoreClassMemberReturns all property keys relevant for the given entity type,
ARCCore.PKHTMLAttribute.EncoderARCCoreClassMemberSee -Encoder-.
ARCCore.PK.GetObligatoryValuesForEntityTypeARCCoreClassMemberReturns all obligatory values (based on -IsObligatory-)
ARCCore.PKRelAttribute.EnforceReferentialIntegrityARCCoreClassMemberSee -EnforceReferentialIntegrity-.
ARCCore.PKHTMLAttribute.IsDefaultARCCoreClassMemberDoes not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCCore.PKLogAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.PK.AllEnumsARCCoreClassMemberAll enums for the whole application.
ARCCore.PKRelAttribute.IsDefaultARCCoreClassMemberDoes not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCCore.IHTMLEncoderARCCoreClassPseudo-interface signifying that implementing class has a static metod called 'Encode' for encoding a string to HTML.
ARCCore.PKLogAttribute.DoNotLogAtAllARCCoreClassMemberSee -DoNotLogAtAll-.
ARCCore.PK.AllPKEnumsARCCoreClassMemberAll -PropertyKeyEnum--tagged enums for the whole application.
ARCCore.PKTypeAttributeARCCoreClassContains the most basic essential information about a property key, like its description, -Type-, -Cardinality-, -IsObligatory- and -DefaultValue-.
ARCCore.PKLogAttributeARCCoreClassExplains how logging of changes to a property should be done.
ARCCore.PKLogAttribute.IsDefaultARCCoreClassMemberDoes not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCCore.PK.__enumARCCoreClassMemberThis information is also found as EnumMember.
ARCCore.PKTypeAttribute.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.PKLogAttribute.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.PKRelAttributeARCCoreClassDescribes relationships between entities (between tables in RDBMS terms).
ARCCore.PKHTMLAttributeARCCoreClassContains pointer to HTML encoder for a property.
ARCCore.IP.TrySetPPARCCoreClassMemberSetPP = set property of property. Sets property of entity contained within this class.
ARCCore.PKTypeAttribute.StandardValidatorAndParserARCCoreClassMemberReturns validator and parser for well known types like string, int, long, bool, DateTime, TimeSpan, Type, Uri.
ARCCore.IPARCCoreClassIP = IProperty.
ARCCore.PKRelAttribute.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.IP.GetKeysEqualToValueARCCoreClassMemberReturns properties which themselves again have key and value equal to the given key and value.
ARCCore.PKTypeAttribute.StandardCleanerARCCoreClassMemberReturns a cleaner for well known types like bool
ARCCore.IP.TryGetV Overload2ARCCoreClassMemberThe actual value of the property. Mostly relevant for single-value properties like -PValue-.
ARCCore.PKRelAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.IP.OnTrySetPARCCoreClassMemberEvent handler to be called by -TrySetP- before it changes a property value (but AFTER it has done any validity checks, that is, after it has 'decided' to return TRUE, in other words, event handler should be called when change is guaranteed to go through, but before it actually has been done).
ARCCore.PKTypeAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.IP.IncARCCoreClassMemberIncrements given property key by 1. Sets to 1 if not found. Uses long, not integer.
ARCCore.PKRelAttribute.ForeignEntityARCCoreClassMemberSee -ForeignEntity-.
ARCCore.IP.TryGetPARCCoreClassMemberGets a single property for this object
ARCCore.PKTypeAttribute.TypeARCCoreClassMemberSee -Type-.
ARCCore.IP.DecARCCoreClassMemberDecrements given property key by 1. Sets to -1 if not found. Uses long, not integer.
ARCCore.PKRelAttribute.OppositeTermARCCoreClassMemberSee -OppositeTerm-.
ARCCore.IP.ValuesARCCoreClassMemberReturns all the values (all the properties) for this instance.
ARCCore.IP.LogARCCoreClassMemberThe 'final' overload of -Log- that is called by the other overloads.
ARCCore.IP.ToPropertyStreamARCCoreClassMemberTurns object into a -PropertyStream-
ARCCore.PKTypeAttribute.CardinalityARCCoreClassMemberSee -Cardinality-.
ARCCore.IP.LoggerARCCoreClassMemberDescribes a logger.
ARCCore.IP.LogExecuteTimeARCCoreClassMemberTimes the execution of the given function and logs details about elapsed time.
ARCCore.IP.ToJSONSerializeableARCCoreClassMemberPrepares the data into a format acceptable for System.Text.Json.JsonSerializer.Serialize.
ARCCore.PKTypeAttribute.DefaultValueARCCoreClassMemberSee -DefaultValue-.
ARCCore.IP.AllIPDerivedTypesARCCoreClassMemberAll relevant -IP--derived types for the whole application.
ARCCore.IP.HandleExceptionARCCoreClassMemberNote that most relevant to use for -PConcurrent-.
ARCCore.IP.GetValueForJSONSerializerARCCoreClassMemberPractical approach to serializing of -IP- based values to JSON.
ARCCore.PKTypeAttribute.IsObligatoryARCCoreClassMemberSee -IsObligatory-.
ARCCore.IP.AllIPDerivedTypesWithPKEnumARCCoreClassMemberAll relevant -IP--derived types for the whole application for which the also is defined a -PropertyKeyEnum-.
ARCCore.IP.TryParseDtrARCCoreClassMemberParses a PropertyStreamLine- beginning with -dtr-.
ARCCore.IP.TrySetPARCCoreClassMemberSet property regardless of whether exists or not.
ARCCore.PKTypeAttribute.IsDefaultARCCoreClassMemberDoes not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCCore.PCollection.GetKeysEqualToValueARCCoreClassMemberReturns properties which themselves again have key and value equal to the given key and value.
ARCCore.IP.TryGetV Overload1ARCCoreClassMemberThe actual 'unpacking' of the object.
ARCCore.IP.TryGetPVARCCoreClassMemberGets a single property's value for the given property key.
ARCCore.IP.InitializeARCCoreClassMemberNote that has a default implementation (doing nothing).
ARCCore.PCollection.TryGetPARCCoreClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.IP.DeepCopyARCCoreClassMemberCreates a deep copy of this object instance, that is, a copy with all new object instances (except for immutable objects).
ARCCore.IP.IsValidARCCoreClassMemberNote that by default all properties are 'valid' but because of -NoRealDeletion-, we must have a mechanism for invalidating properties. This property returns FALSE if property has been invalidated and timestamp for invalidation is not '0001-01-01'.
ARCCore.IP.AssertIntegrityARCCoreClassMemberSee -TryAssertIntegrity-.
ARCCore.PCollection.TryGetVARCCoreClassMemberNote 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).
ARCCore.IP.AddPV Overload2ARCCoreClassMemberNOTE: The different AddPV / AddP overloads should only be used if you want an assertion against the
ARCCore.IP.ItemARCCoreClassMemberOffers string-based direct indexing.
ARCCore.IP.TryAssertIntegrityARCCoreClassMemberAsserts the integrity of this entity.
ARCCore.PCollection.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.IP.AddPV Overload1ARCCoreClassMemberAdds a property value (as a -PValue-) for this objectThrows -KeyAlreadyExistsException- when relevant.
ARCCore.IP.KeysARCCoreClassMemberReturns all the keys for this instance.
ARCCore.IP.ToStringARCCoreClassMemberThe ToString()-implementation in the classes implementing this interface is supposed to give a short concise representation of the object for debugging and logging purposes, that is, intended for human consumption. The most 'important' implementation is probably the one in -PRich- (-ToString-) because that one is often the basis for your entity classes like 'Customer', 'Order' and so on
ARCCore.PII.TryGetPARCCoreClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.IP.AllIPDerivedTypesWithPKEnumApplicationSpecificARCCoreClassMemberAll relevant -IP--derived types for the -ApplicationSpecificCode- part of the application for which also is defined a -PropertyKeyEnum-.
ARCCore.P.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.IP.AddPARCCoreClassMemberAdds a property for this object.
ARCCore.PII.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.IP.AllIPDerivedEntityCollectionClassesDictARCCoreClassMemberAll -IP--derived types for which is found a corresponding class with name like '{EntityType}Collection'
ARCCore.ICreatedARCCoreClassA dummy interface signifying that implementing class has the ability to store (in-memory) metadata -Created-
ARCCore.IP.AddOrUpdatePARCCoreClassMemberDuplicates functionality of SetP.
ARCCore.IPIIARCCoreClassFuture expansion, using different classes for storing, not only -PII-.
ARCCore.IP.AllIPDerivedTypesInludingGenericAndAbstractARCCoreClassMemberAll relevant -IP--derived types (except the interface -IP- itself) known to the application.
ARCCore.PCollectionARCCoreClassA class useful for storing a collection of entities (a table in RDBMS-terms) because it implements -Indexing-.
ARCCore.IP.GetOrAddPVARCCoreClassMemberGets value. If not set then value will be added
ARCCore.IIKIIARCCoreClassRelated to -PII-, property for storing individual items
ARCCore.IP.AllIPDerivedTypesDictARCCoreClassMemberProvides lookup of a type in -AllIPDerivedTypes- given its string representation.
ARCCore.PCollection.TrySetPPARCCoreClassMemberReplaces default interface method -TrySetPP-.
ARCCore.IP.GetPVARCCoreClassMemberGets a single property's value for this object. Returns default value if not successful.
ARCCore.PValueEmpty.ToPropertyStreamARCCoreClassMemberTypicall return value could be something like
ARCCore.IGetKeysEqualToValueARCCoreClassInterface stating that implementing class does not use the default implementation of -GetKeysEqualToValue- (which does not use -Indexing-) but has replaced it with a more efficient implementation assumed to utilize -Indexing-.
ARCCore.PExact<TEnumType>.SetPVDirectARCCoreClassMemberHigh performance alternative to -TrySetP-, accessing -Storage- more direct.
ARCCore.IP.AllIPDerivedTypesDictIKTypeARCCoreClassMemberSame as -AllIPDerivedTypesDict- except that value is -IKType-, not string.

Generated 2025-10-03 13:06:21.725 UTC