Represents the definition of an object’s attribute.
| Constant | Description |
|---|---|
| VALUE_TYPE_BOOLEAN: Number = 8 | Boolean value type. |
| VALUE_TYPE_DATE: Number = 6 | Date value type. |
| VALUE_TYPE_DATETIME: Number = 11 | Date and Time value type. |
| VALUE_TYPE_EMAIL: Number = 12 | Email value type. |
| VALUE_TYPE_ENUM_OF_INT: Number = 31 | Enum of int value type. |
| VALUE_TYPE_ENUM_OF_STRING: Number = 33 | Enum of String value type. |
| VALUE_TYPE_HTML: Number = 5 | HTML value type. |
| VALUE_TYPE_IMAGE: Number = 7 | Image value type. |
| VALUE_TYPE_INT: Number = 1 | int value type. |
| VALUE_TYPE_MONEY: Number = 9 | Money value type. |
| VALUE_TYPE_NUMBER: Number = 2 | Number value type. |
| VALUE_TYPE_PASSWORD: Number = 13 | Password value type. |
| VALUE_TYPE_QUANTITY: Number = 10 | Quantity value type. |
| VALUE_TYPE_SET_OF_INT: Number = 21 | Set of int value type. |
| VALUE_TYPE_SET_OF_NUMBER: Number = 22 | Set of Number value type. |
| VALUE_TYPE_SET_OF_STRING: Number = 23 | Set of String value type. |
| VALUE_TYPE_STRING: Number = 3 | String value type. |
| VALUE_TYPE_TEXT: Number = 4 | Text value type. |
| Property | Description |
|---|---|
ID: String (read-only) | Returns the ID of the attribute definition. |
attributeGroups: Collection (read-only) | Returns all attribute groups the attribute is assigned to. |
defaultValue: ObjectAttributeValueDefinition (read-only) | Return the default value for the attribute or null if none is defined. |
displayName: String (read-only) | Returns the display name for the attribute, which can be used in the user interface. |
key: Boolean (read-only) | Identifies if the attribute represents the primary key of the object. |
mandatory: Boolean (read-only) | Checks if this attribute is mandatory. |
multiValueType: Boolean (read-only) | Returns |
objectTypeDefinition: ObjectTypeDefinition (read-only) | Returns the object type definition in which this attribute is defined. |
(read-only) | Returns true if the attribute is of type ‘Set of’. |
system: Boolean (read-only) | Indicates if the attribute is a pre-defined system attribute or a custom attribute. |
unit: String (read-only) | Returns the attribute’s unit representation such as inches for length or pounds for weight. |
valueTypeCode: Number (read-only) | Returns a code for the data type stored in the attribute. |
values: Collection (read-only) | Returns the list of attribute values. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| getAttributeGroups() | Returns all attribute groups the attribute is assigned to. |
| getDefaultValue() | Return the default value for the attribute or null if none is defined. |
| getDisplayName() | Returns the display name for the attribute, which can be used in the user interface. |
| getID() | Returns the ID of the attribute definition. |
| getObjectTypeDefinition() | Returns the object type definition in which this attribute is defined. |
| getUnit() | Returns the attribute’s unit representation such as inches for length or pounds for weight. |
| getValueTypeCode() | Returns a code for the data type stored in the attribute. |
| getValues() | Returns the list of attribute values. |
| isKey() | Identifies if the attribute represents the primary key of the object. |
| isMandatory() | Checks if this attribute is mandatory. |
| isMultiValueType() | Returns |
Returns true if the attribute is of type ‘Set of’. | |
| isSystem() | Indicates if the attribute is a pre-defined system attribute or a custom attribute. |
| requiresEncoding() | Returns a boolean flag indicating whether or not values of this attribute definition should be encoded using the encoding=“off” flag in ISML templates. |
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
Boolean value type.
Date value type.
Date and Time value type.
Email value type.
Enum of int value type.
Enum of String value type.
HTML value type.
Image value type.
int value type.
Money value type.
Number value type.
Password value type.
Quantity value type.
Set of int value type.
Set of Number value type.
Set of String value type.
String value type.
Text value type.
(read-only)Returns the ID of the attribute definition.
(read-only)Returns all attribute groups the attribute is assigned to.
(read-only)Return the default value for the attribute or null if none is defined.
(read-only)Returns the display name for the attribute, which can be used in the user interface.
(read-only)Identifies if the attribute represents the primary key of the object.
(read-only)Checks if this attribute is mandatory.
(read-only)Returns true if the attribute can have multiple values.
Attributes of the following types are multi-value capable:
Additionally, attributes of the following types can be multi-value enabled:
(read-only)Returns the object type definition in which this attribute is defined.
(read-only)Returns true if the attribute is of type 'Set of'.
Deprecated:
Use isMultiValueType() instead.
Warning
(read-only)Indicates if the attribute is a pre-defined system attribute or a custom attribute.
(read-only)Returns the attribute's unit representation such as inches for length or pounds for weight. The value returned by this method is based on the attribute itself.
(read-only)Returns a code for the data type stored in the attribute. See constants defined in this class.
(read-only)Returns the list of attribute values. In the user interface only the values specified in this list should be offered as valid input values.
The collection contains instances of ObjectAttributeValueDefinition.
Returns all attribute groups the attribute is assigned to.
Returns:
Return the default value for the attribute or null if none is defined.
Returns:
Returns the display name for the attribute, which can be used in the user interface.
Returns:
Returns the ID of the attribute definition.
Returns:
Returns the object type definition in which this attribute is defined.
Returns:
Returns the attribute's unit representation such as inches for length or pounds for weight. The value returned by this method is based on the attribute itself.
Returns:
Returns a code for the data type stored in the attribute. See constants defined in this class.
Returns:
Returns the list of attribute values. In the user interface only the values specified in this list should be offered as valid input values.
The collection contains instances of ObjectAttributeValueDefinition.
Returns:
Identifies if the attribute represents the primary key of the object.
Returns:
Checks if this attribute is mandatory.
Returns:
Returns true if the attribute can have multiple values.
Attributes of the following types are multi-value capable:
Additionally, attributes of the following types can be multi-value enabled:
Returns:
true if attributes can have multiple values,
otherwise falseReturns true if the attribute is of type 'Set of'.
Deprecated:
Use isMultiValueType() instead.
Warning
Indicates if the attribute is a pre-defined system attribute or a custom attribute.
Returns:
Returns a boolean flag indicating whether or not values of this attribute definition should be encoded using the encoding="off" flag in ISML templates.
Returns:
j