...
The Business Entity Descriptor uses the Annotation based Type Descriptor to provide specific information about the usage of Business Entities at runtime. The information can be used by tools that use the information provided by the Business Entity Descriptor to dynamically adjust the behavior based on definitions in the Business Entity.
As the Business Entity Descriptor is based on the Annotation based Type Descriptor, the utility described on that page must be used after inserting necessary annotations in a Business Entity source code.
...
Attribute Name | Description |
---|---|
Name (required) | The name of the Temp-Table which is described here |
ReadOnly | Logical value, describing if the Temp-Table is considered read-only in this Business Entity |
MandatoryColumns | Comma delimited list of mandatory columns |
ReadOnlyColumns | Comma delimited list of columns that are read-only |
GetInitialValues | Logical value, indicating whether the Business Entity's GetInitialValues method is called to set initial values for a new record. If FALSE, the temp-tables's default initial values are used. The default value is FALSE. |
AddOnlyColumns | Returns the list of columns only enabled during add |
DefaultSort | Returns the default sort option. Including the BY and the table name |
PrimaryKey | Comma delimited list of column (field) names that represent the Primary Key Fields |
NonFilterableColumns | Comma delimited list of column (field) names of columns that do not support filtering |
NonSortableColumns | Comma delimited list of column (field) names of columns that do not support sorting |
PerformValidation | Logical value, indicating whether the Business Entity should perform automatic validation based on AddOnlyColumns, MandatoryColumns, ReadOnly, ReadOnlyColumns. The default value is FALSE. |
@BusinessEntityView
The BusinessEntityView annotation allows to describe views of the Business Entity, similar to the parameters required in the SmartBusinessEntityAdapter when accessing the Business Entity:
...
The InvokeMethod annotation allows the description of method that are invokable through the Service Interface or the Service Adapter.
Attribute Name | Description |
---|---|
ParameterClassName | Name of the class name expected as the parameter object of the invokable method. Invokable methods expect the dataset of the Business Entity as INPUT-OUTPUT parameter and a further parameter object (which should be serializable if the method should be accessible from a client). |
DatasetInput | Is the dataset parameter expected for INPUT |
DatasetOutput | Is the dataset parameter expected for OUTPUT |
template (ignored) | The template parameter is commonly used for Invokable method for the generation of proxy methods in the DatasetModel classes. This parameter is not required for the Business Entity Descriptor and will be ignored |
...
The Business Entity Descriptor is accessed by calling into the GetBusinessEntityDescriptor method of the Business Entity (base class) through the ServiceInterface:InvokeMethod method.
The parameter class GetBusinessEntityDescriptorParameter allows to specify if the call should also return the Business Entity Dataset.
...
Accessing the Business Entity Descriptor from the Frontend
The Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptorClient with the default implementation BusinessEntityDescriptorClient provides access and a cache for the Business Entiy Entity Descriptor and should be used on the client.
...