Class ObjectTypeDefinition
The class provides access to the meta data of a system object or custom object. A short example should suffice to demonstrate how this metadata can be used in a script:
| Property | Description |
|---|---|
ID: String (read-only) | Returns the type id of the business objects. |
attributeDefinitions: Collection (read-only) | Returns a collection of all declared attributes for the object. |
attributeGroups: Collection (read-only) | Returns a collection of all declared attribute groups. |
displayName: String (read-only) | Returns the display name of the definition, which can be used in the user interface. |
system: Boolean (read-only) | Identifies if this object definition is for a system type or a custom type. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| getAttributeDefinitions() | Returns a collection of all declared attributes for the object. |
| getAttributeGroup(String) | Returns the attribute group with the given name within this object type definition. |
| getAttributeGroups() | Returns a collection of all declared attribute groups. |
| getCustomAttributeDefinition(String) | Returns the custom attribute definition with the given name. |
| getDisplayName() | Returns the display name of the definition, which can be used in the user interface. |
| getID() | Returns the type id of the business objects. |
| getSystemAttributeDefinition(String) | Returns the system attribute definition with the given name. |
| isSystem() | Identifies if this object definition is for a system type or a custom type. |
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
- ID: String
(read-only) Returns the type id of the business objects.
- attributeDefinitions: Collection
(read-only) Returns a collection of all declared attributes for the object. The collection contains both system and custom attributes. There might be system and custom attribute with identical names. So the name of the attribute is not a uniqueness criteria. Additional the isCustom() flag must be checked.
- attributeGroups: Collection
(read-only) Returns a collection of all declared attribute groups. A attribute group is a collection of attribute, which are typically displayed together as a visual group.
- displayName: String
(read-only) Returns the display name of the definition, which can be used in the user interface.
- system: Boolean
(read-only) Identifies if this object definition is for a system type or a custom type.
- getAttributeDefinitions(): Collection
Returns a collection of all declared attributes for the object. The collection contains both system and custom attributes. There might be system and custom attribute with identical names. So the name of the attribute is not a uniqueness criteria. Additional the isCustom() flag must be checked.
Returns:
- a collection of all declared attributes for the object.
- getAttributeGroup(name: String): ObjectAttributeGroup
Returns the attribute group with the given name within this object type definition.
Parameters:
- name - The name of the attribute scope to return.
Returns:
- The matching attribute scope or
nullif no such scope exists.
- getAttributeGroups(): Collection
Returns a collection of all declared attribute groups. A attribute group is a collection of attribute, which are typically displayed together as a visual group.
Returns:
- a collection of all declared attribute groups.
- getCustomAttributeDefinition(name: String): ObjectAttributeDefinition
Returns the custom attribute definition with the given name. The method returns null if no custom attribute is defined with that name.
Parameters:
- name - The unique name of the custom attribute definition within the object type.
Returns:
- The matching attribute definition or
nullin case no such definition exists.
- getDisplayName(): String
Returns the display name of the definition, which can be used in the user interface.
Returns:
- the display name of the definition, which can be used in the user interface.
- getID(): String
Returns the type id of the business objects.
Returns:
- the type id of the business objects.
- getSystemAttributeDefinition(name: String): ObjectAttributeDefinition
Returns the system attribute definition with the given name. The method returns null if no system attribute is defined with that name. Only system objects have system attributes. A CustomObject has no system attributes and so the method will always return null for a CustomObject.
Parameters:
- name - The unique name of the custom attribute definition within the object type.
Returns:
- The matching attribute definition or
nullin case no such definition exists.
- isSystem(): Boolean
Identifies if this object definition is for a system type or a custom type.
Returns:
- true if this object definition is for a system type, false otherwise.