Class EnumValue
The class represents a single value for an Enumeration type. Enumeration types can be configured through the business manager for custom attributes. Some system attributes, e.g. the order status, are also of Enumeration types.
Each EnumValue has a base value and a display value. The type of the base value can be either String or Integer. Every EnumValue has a display value.
If the value of an Enumeration type object attribute is
null, when that attribute is accessed an EnumValue is returned
that has a base value of null, rather than null
itself. This means that empty(object.attribute) would be
false, and empty(object.attribute.value) would be
true
.
| Property | Description |
|---|---|
displayValue: String (read-only) | Returns the display value of the enumeration value. |
value: Object (read-only) | Returns the value of the enumeration value. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| getDisplayValue() | Returns the display value of the enumeration value. |
| getValue() | Returns the value of the enumeration value. |
| toString() | Same as getDisplayValue(). |
| valueOf() | According the ECMA specification, this method returns the "natural" primitive value of this 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
- displayValue: String
(read-only) Returns the display value of the enumeration value. If no display value is configured the method return the string representation of the value.
- value: Object
(read-only) Returns the value of the enumeration value. This is either an integer value or a string.
- getDisplayValue(): String
Returns the display value of the enumeration value. If no display value is configured the method return the string representation of the value.
- getValue(): Object
Returns the value of the enumeration value. This is either an integer value or a string.
- toString(): String
Same as getDisplayValue().
- valueOf(): Object
According the ECMA specification, this method returns the "natural" primitive value of this object. Here it is equivalent to getValue().