IDataAttribute Interface |
Abstract interface to data attribute of a domain object
Namespace: Aloe.SystemFrameworks.Domain
Assembly: Aloe.SystemFrameworks.Domain (in Aloe.SystemFrameworks.Domain.dll) Version: 20.1.3.5
SyntaxThe IDataAttribute type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | BaseInfo |
Gets the base information.
|
| DefaultValue |
Gets the default value of the attribute.
|
| Expressions |
Gets the recalc expression.
|
| IsBlob |
Gets a value indicating whether this attribute data is BLOB.
|
| IsPersistent |
Gets a value indicating whether this attribute is persistent.
Only persistent attributes support track changes.
|
| LocalizedName |
Gets the name of the attribute in the current UI culture.
|
| Name |
Gets the name of the data attribute
|
| PrimitiveValueType |
Gets the primitive type or null. Used in public APIs to represent a complex value as a primitive value.
For example Quantity and Amount attributes may have Decimal primitive type.
|
| ReadOnly |
Is the Property read-only
|
| SupportsGet |
Gets a value indicating whether the attribute supports getting a value.
|
| SupportsSet |
Gets a value indicating whether the attribute supports setting a value.
|
| ValueType |
Returns the Type of the data, that this attribute stores
|
Methods| Name | Description | |
|---|---|---|
 | FilterBy |
Creates and returns filter condition for the data attribute
|
| GetComplexTypeAccessor |
Gets the complex type value accessor or null if the attribute does not support it.
Complex type values are frequently used in Entity Data Models.
|
| GetDisplayValueAccessor |
Gets the display text accessor or null if the attribute does not support it.
The display value is localized in the current thread culture
and is suitable for displaying and modification by end users.
|
| GetInvariantStringAccessor |
Gets the text value accessor or null if the attribute does not support it.
The text value is used when importing from or exporting to text files or streams.
|
| GetPrimitiveValueAccessor |
Gets the primitive value accessor or null if the attribute does not support it.
The type of the value is represented by PrimitiveValueType.
|
| GetUntypedValue |
Gets the value of the data attribute for the specified domain object
|
| OnDataAttributeChanged |
Raises the DataAttributeChanged event.
|
| Prepare |
Performs attribute-specific work to prepare the attribute. For example calculated attributes must be compiled.
Called by the system after the attribute is added to the repository.
|
| SetDefaultValue |
Sets the attribute to its default value.
|
| SetUntypedValue |
Sets the value of the data attribute for the specified entity object
|
| ShouldRecalculateLateDefault |
Returns true if the attribute should be recalculated for the specified object.
|
Events| Name | Description | |
|---|---|---|
 | DataAttributeChanged |
The data attribute changed event. Fired after the data attribute changes for an object.
|
Extension Methods| Name | Description | |
|---|---|---|
 | GetUntypedValueAccessor |
Gets the untyped value accessor.
(Defined by IDataAttributeExtensions.) |
| IsNull |
Determines whether value of the attribute of the specified object is null.
(Defined by IDataAttributeExtensions.) |
Remarks
Data attributes map the data between domain attributes and underlying data storage structures.
Data attributes contain storage logic and should NOT contain business logic. For example, it is ok
to transform enums into numbers and vice versa, but it is not ok to put domain validation logic in the
attribute itself.
See Also