Business Framework properties
When modeling business entities for the business framework, several special properties defined by the BusinessFramework profile allow you to specify characteristics of the entities. The following tables list these properties, and describes how they are used.
Classes
The following properties apply to classes for business entities:
![[spacer]](images/ms913152.1p(en-us,msdn.10).gif)
Property |
Description |
|---|---|
AppliedPermissionSetType |
Reserved for future use. |
AppliedPermissionSetVirtualCollection |
Reserved for future use. |
Author |
A string value that can be used to indicate who created the business entity. |
BusinessFramework |
Reserved for future use. |
Category |
A string value that can be used to group business entities. |
ComponentContainer |
Specifies whether the entity is a component container. Component containers are used to indicate the hierarchy relationship of the entities that have been defined. Refer to Component containers for more information. |
EntityType |
Reserved for future use. |
HelpLink |
Reserved for future use. |
Hidden |
Specifies whether the business entity is visible in the system. True indicates the entity won’t be accessible, while false indicates it will. |
KeyIsAbstract |
Reserved for future use. |
Root |
True indicates that the entity is a root entity, and the entity’s data can be accessed directly. False indicates the entity must be accessed through a relationship with another entity. |
Version |
A string value that can be used to indicate the version of the business entity. |
ExplorerImageIndex |
Reserved for future use. |
ExplorerPath |
Reserved for future use. |
ImagePath |
Reserved for future use. |
Attributes
The following properties apply to attributes for business entities:
Property |
Description |
|---|---|
Author |
A string value that can be used to indicate who created the attribute. |
Category |
A string value that can be used to group attributes. |
Customized |
Reserved for future use. |
DefaultQueryMember |
True indicates the property will be included in the default query for the entity. False indicates the property won’t be included. The hypermedia capability of the Query Web Service uses default queries. |
DisplayFormat |
Reserved for future use. |
EntityPropertyValidator |
A string that specifies the set of rules the property’s value must conform to in order to be considered valid. This property is typically used to validate data when an entity is being used to save information in a database. |
EntryFormat |
Reserved for future use. |
ExplorerPriority |
A long that specifies the order of the attributes for the entity. The value 1 indicates the highest priority. The attributes with this priority will appear first in the list. The attributes with value 2 will appear next, and so on. The value 0 (zero) is the default, and indicates the lowest priority. Attributes that have the same ExplorerPriority value will be grouped, but will appear in an indeterminate order. |
HelpLink |
Reserved for future use. |
Hidden |
True indicates the attribute won’t appear in any list of attributes for the entity. False indicates the attribute will be visible. |
HypermediaPriority |
Reserved for future use. |
IsAbstract |
A boolean that indicates whether an attribute is concrete and will persist data to a table. Used in inheritance scenarios. |
IsTypeIndicator |
Reserved for future use. |
MaxKeyableLength |
An integer that indicates the maximum length of the value that can be used for the attribute. |
MinKeyableLength |
An integer that indicates the minimum length of the value that can be used for the attribute. |
PropertyType |
Specifies whether the attribute is a simple property or not a property for the entity. |
Read/Write |
Specifies how data can be accessed through the attribute. ReadOnly indicates that data can be read from the attribute. WriteOnly indicates that data can only be written to the attribute. ReadWrite indicates data can be read and written for the attribute. |
SecurityTaskID |
Reserved for future use. |
Version |
A string value that can be used to indicate the version of the attribute. |
VisibleID |
True indicates the attribute will be displayed as the ID for the entity, rather than the attribute that is stereotyped as <<id>>. |
Operations
The following properties apply to operations for business entities:
Property |
Description |
|---|---|
SecurityTaskID |
Reserved for future use. |
Associations and compositions
The following properties apply to associations and compositions that specify the relationships between business entities:
Property |
Description |
|---|---|
End1HypermediaNavigable |
Indicates that the link is accessible through the Hypermedia subsystem for the specified link end. |
End2HypermediaNavigable |
Indicates that the link is accessible through the Hypermedia subsystem for the specified link end. |