Class ObjectAttributeGroup

Represents a group of object attributes.

Property Summary 

PropertyDescription
ID: String (read-only)Returns the ID of this group.
attributeDefinitions: Collection (read-only)Returns all attribute definitions for this group.
description: String (read-only)Returns the description of this group in the current locale.
displayName: String (read-only)Returns the display name of this group.
objectTypeDefinition: ObjectTypeDefinition (read-only)Returns the object type definition to which this attribute group belongs.
system: Boolean (read-only)Identifies if this is an sytem or a custom attribute group.

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 

MethodDescription
getAttributeDefinitions()Returns all attribute definitions for this group.
getDescription()Returns the description of this group in the current locale.
getDisplayName()Returns the display name of this group.
getID()Returns the ID of this group.
getObjectTypeDefinition()Returns the object type definition to which this attribute group belongs.
isSystem()Identifies if this is an sytem or a custom attribute group.

Methods inherited from class Object 

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

Property Details 

ID 

ID: String (read-only)

Returns the ID of this group.


attributeDefinitions 

attributeDefinitions: Collection (read-only)

Returns all attribute definitions for this group. The collection may contain both system attribute definition as well as custom attribute definitions.


description 

description: String (read-only)

Returns the description of this group in the current locale.


displayName 

displayName: String (read-only)

Returns the display name of this group.


objectTypeDefinition 

objectTypeDefinition: ObjectTypeDefinition (read-only)

Returns the object type definition to which this attribute group belongs.


system 

system: Boolean (read-only)

Identifies if this is an sytem or a custom attribute group. A system attribute group is pre-defined and can not be deleted.


Method Details 

getAttributeDefinitions() 

getAttributeDefinitions(): Collection

Returns all attribute definitions for this group. The collection may contain both system attribute definition as well as custom attribute definitions.

Returns:

  • all attribute definitions for this group.

getDescription() 

getDescription(): String

Returns the description of this group in the current locale.

Returns:

  • the display name of this group.

getDisplayName() 

getDisplayName(): String

Returns the display name of this group.

Returns:

  • the display name of this group.

getID() 

getID(): String

Returns the ID of this group.

Returns:

  • the ID of this group.

getObjectTypeDefinition() 

getObjectTypeDefinition(): ObjectTypeDefinition

Returns the object type definition to which this attribute group belongs.

Returns:

  • the object type definition to which this attribute group belongs.

isSystem() 

isSystem(): Boolean

Identifies if this is an sytem or a custom attribute group. A system attribute group is pre-defined and can not be deleted.

Returns:

  • true if this is a system attribute group, false otherwise.

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!