getDisplayName()
:
String
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.
isSystem()
:
boolean
Identifies if this object definition is for a system type or a custom type.
getAttributeDefinitions
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
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 null
if no such scope exists.
getAttributeGroups
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
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 null
in case no such definition exists.
getDisplayName
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
Returns the type id of the business objects.
Returns:
the type id of the business objects.
getSystemAttributeDefinition
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 null
in case no such definition exists.
isSystem
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.