Entity Object (Model Designer)
Defines an entity in the model. This object inherits properties from the ModelItem object.
Name | Cardinality | Type | Description |
|---|---|---|---|
CollectionName | 0-1 | String | The name of a collection of instances of the entity. If the string is not specified, the value defaults to the same string as Name. This value cannot be an empty string. |
1-N | Object | Specifies the attributes that client applications should use to identify an instance of the entity to the user. | |
0-1 | Object | Specifies the attributes that client applications should show when this entity is displayed. | |
0-1 | Object | Specifies the aggregate attributes client applications should show when this entity is displayed as an aggregate. | |
0-1 | Object | Specifies the attributes used to sort when a sort is requested by this entity. | |
InstanceSelection | 1 | Enum | Determines the client application behavior for selecting instances of the entity, based on the expected number of total instances. There are four options:
|
IsLookup | 0-1 | Boolean | Indicates that the client application should treat the entity as a lookup table instead of a full-fledged entity. |
0-1 | Object | Defines how this entity inherits attributes and roles from other entities. | |
DisjointInheritance | 0-1 | Boolean | Indicates that entities that inherit from this entity are mutually exclusive sets. |
0-1 | Object | The fields, either attributes or roles, of the entity. | |
1 | Object | The database object that represents this entity. | |
0-1 | Object | Attributes to use as filters for this entity. | |
0-1 | Object | Attribute to use as a filter for this entity if SecurityFilters are not available, for example, when the user does not have sufficient permissions. |