[ROOT] / doc / toc / ARCCore / Class / PK
__enum , .ctor , AllEnums , AllPKEnums , BuildFromStringCache , Cardinality , Cleaner , CorrespondingClass , Equals , FromEnum , GetA , GetAllPKForEntityType , GetAllPKForEntityTypeString , GetObligatoryValuesForEntityType , GetTypeMapping , ModifyCleanerAndValidatorAndParserForCardinality , PackObjectForStorageInEntityObject , PackParseResultForStorageInEntityObject , ToString , TryCleanValidateAndParse , TryGetA , TryGetEnum , TryGetFromTypeAndFieldName , TryGetP , TryGetV , TryValidateAndParse , Type , ValidatorAndParser
PK = AgoRapide PropertyKey.
TODO: Implement ToPropertyStream for this class since implements IP (like in PValue<T>).
Describes properties related to an object (an entity).
In RDBMS-terms it describes the field in the schema for the table, like 'Customer.FirstName' or 'Car.Colour')r
Constitutes the basic element of TaggingOfPropertyKeys, and gives the IP mechanism the information it needs in order to implement PropertyAccess.
Contains collection of BasePKAttribute instances which in turn contain the actual attributes like:
PKTypeAttribute: Contains the most basic essential information about a property key.
PKRelAttribute: Describes relationships between entities.
PKHTMLAttribute: Contains pointer to HTML encoder for a property.
PKLogAttribute: Explains how logging of changes to a property should be done.
These are accessed through GetA / TryGetA
See also TaggingOfPropertyKeys.
NOTE: This class is itself an instance of IP because we want to communicate contents of keys in a standardised manner. They can for instance be communicated to other ARNodeType through the ToPropertyStream mechanism.
See also PropertyKeyEnum.
| __enum | This information is also found as EnumMember. |
| .ctor | Constructor with 'object _enum' is necessary in order for ToString to work. |
| AllEnums | All enums for the whole application. |
| AllPKEnums | All PropertyKeyEnum-tagged enums for the whole application. |
| BuildFromStringCache | Builds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-. |
| Cardinality | Returns cardinality from PKTypeAttribute's Cardinality. |
| Cleaner | Cleanup of values, to be used before value is attempted validated. |
| CorrespondingClass | Returns CorrespondingClass based on __enum. |
| Equals | Note 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. |
| FromEnum | Returns the corresponding PK instance from the given PropertyKeyEnum. |
| GetA | Convenience method for easy access to BasePKAttribute with corresponding explaining exception if fails |
| GetAllPKForEntityType | Returns all property keys relevant for the given entity type, |
| GetAllPKForEntityTypeString | Returns all property keys relevant for the given entity type, |
| GetObligatoryValuesForEntityType | Returns all obligatory values (based on IsObligatory) |
| GetTypeMapping | Returns the relevant property key for a given type entity-type and field-type. |
| ModifyCleanerAndValidatorAndParserForCardinality | Called from Initialize after _cleaner and _validatorAndParser have been set. |
| PackObjectForStorageInEntityObject | See PackParseResultForStorageInEntityObject for documentation. |
| PackParseResultForStorageInEntityObject | Packs result of parsing into a IP-derived class, suitable for sending to AddOrUpdateP. |
| ToString | Caching is supposed to be useful because may be called quite often. |
| TryCleanValidateAndParse | Cleans and parses the value according to specifications for this property key. |
| TryGetA | Convenience method for easy access to BasePKAttribute. |
| TryGetEnum | 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. |
| TryGetFromTypeAndFieldName | 3 items |
| TryGetP | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
| TryGetV | Only type of PK, string or type of __enum is allowed to ask for (as TRequest generic type parameter). |
| TryValidateAndParse | Parses the value according to specifications for this property key. |
| Type | Returns type from PKTypeAttribute's Type. |
| ValidatorAndParser | Validates and parses a value. |
Generated 2024-04-18 21:40:27.418 UTC