/ doc / DocFrag / ARCCore.ITypeDescriber / Attribute

Attribute

Edit keys at this level only

AssemblyName = ARCCore
ClassNamespace = ARCCore
ClassType = ITypeDescriber
Description = Provides a standardized mechanism for describing single-property values (like 'PhoneNumber' of 'Customer' for instance).0x000D0x000A0x000D0x000A(The difference between -ITypeDescriber- and -IP- is that the former must be stored 'inside' an -IP-.0x000D0x000AIn RDBMS-terms a -ITypeDescriber- is the Field stored within a -IP- which is the Post.)0x000D0x000A0x000D0x000AThe most important functionality usually provided is validation and parsing in a standardized manner.0x000D0x000A0x000D0x000AThis is done by a static method call 'EnrichKey' which is supposed to be available in a class 'implementing' this interface.0x000D0x000AIn this manner, types implementing this 'interface' is by this principle able to describe themselves to AgoRapide).0x000D0x000AFor a typical example, see -EnrichKey-.0x000D0x000A0x000D0x000ANote how this interface in itself is empty 0x000D0x000A(apart from -GetSyntaxHelp- which is just a suggestion to use in your implementing classes.)0x000D0x000A0x000D0x000ASee -Initialize- for where this 'interface' is actually used.0x000D0x000A0x000D0x000AEnrichKey should have the following signature:0x000D0x000A  public static void EnrichKey(PK k)0x000D0x000A0x000D0x000AA typical method will set -ValidatorAndParser- although other attributes of -PK- may also be changed (which gives rise to the somewhat strange name for the method 'EnrichKey').0x000D0x000A0x000D0x000A(note that for very common types like string, int, long, bool, DateTime, TimeSpan, Type, Uri and so on -PKTypeAttribute- provides a -StandardValidatorAndParser-.)0x000D0x000A0x000D0x000AA typical implementation can look like this:0x000D0x000A0x000D0x000A   public static void EnrichKey(PK k) 0x007B0x000D0x000A      k.SetValidatorAndParser(new Func0x003Cstring, ParseResult0x003E(value =0x003E0x000D0x000A        TryParse(value, out var retval, out var errorResponse) ?0x000D0x000A          ParseResult.CreateOK(retval) :0x000D0x000A          ParseResult.CreateError(errorResponse)0x003B0x000D0x000A      ))0x003B0x000D0x000A  0x007D0x000D0x000A0x000D0x000AThe typical TryParse method in the implementation class should follow the ordinary .NET pattern with the addition of a 'out string errorResponse' parameter which can communicate WHY the value was not valid for parsing. This helps a lot with error messages, making an API for instance much more user friendly.0x000D0x000A0x000D0x000ANote the the implementation class should also overrride object.ToString() to a format actually understood by the ValidatorAndParser returned. This is necessary for the storage mechanism, like -PropertyStream- to work (serialization and de-serialization of objects).
LongDescription = See also -IP- which describes multiple value properties (that is, 'entities' like Customer, Product, Order). 0x000D0x000ANote that the use of a static method is a practical choice since it avoids AgoRapide having to instantiate the class for what is essential a static one-off operation done only once (for instance at application initialization, or on-demand).0x000D0x000AThis however means that the compiler is unable to check if your class really implements 'EnrichKey' as 'promised' by the fact of it being marked as implementing this interface. Missing implementations will show up at runtime with a helpful and explanatory error messages.0x000D0x000A0x000D0x000ANote that for some attributes you actually have a choice of where to specify them.0x000D0x000A(example below assumes a PKDataAttribute-class with a property called 'InvalidValueExample')0x000D0x000ATODO: FIND ETTER EXAMPLES WHEN SOME REAL BasePKAttribute subclasses are defined in AgoRapide0x000D0x000A0x000D0x000AYou can specify either by0x000D0x000A0x000D0x000A1) Tagging directly the corresponding 'enum' field (enums of type -PropertyKeyEnum-) with some -PKTypeAttribute- like:0x000D0x000A0x000D0x000Aenum CustomerP 0x007B0x000D0x000A  ...0x000D0x000A  0x005BPKType(Type=DateOfBirth)0x005D0x000D0x000A  0x005BPKData(InvalidValueExample = "1968-13-09")0x005D0x000D0x000A  DateOfBirth,0x000D0x000A  ...0x000D0x000A0x007D0x000D0x000A0x000D0x000A(but then you will have to do that everywhere you are using the implementing class (in this example the type 'DateOfBirth') because there will be a separate -PK- generated for each 'enum' field).  0x000D0x000Aor 0x000D0x000A2) by setting them when the resulting -PK- is passed to EnrichKey (from wherever 'DateOfBirth' is used) like (note, code is somewhat simplified):0x000D0x000A0x000D0x000A   public class DateOfBirth : ITypeDescriber 0x007B0x000D0x000A      ...0x000D0x000A      public static void EnrichKey(PK k) 0x007B0x000D0x000A          var pkData = new PKDataAttribute()0x003B0x000D0x000A          pkData.AddPV(PKDataAttributeP.InvalidValueExample.A(), "1968-13-09")0x003B0x000D0x000A          k.AddP(IKType.FromType(pkData.GetType()), pkData)0x003B0x000D0x000A      0x007D)0x003B0x000D0x000A   0x007D0x000D0x000A0x000D0x000AThe latter method is supposedly better.0x000D0x000A0x000D0x000ANote that attributes like -ValidatorAndParser- can only be set through EnrichKey because they are too complex for the -Attribute- mechanism
SubTypes = FunctionKeyAWFiscalYear

Edit keys at all sub levels.
NOTE: Edits are always additive. Use 'Invalid' in order to delete keys.

Edit single sub keys only: AssemblyName / ClassNamespace / ClassType / Description / LongDescription / SubTypes

Generated 2025-06-08 18:36:03.680 UTC