Name | EnumeratedValueInfo | |
---|---|---|
Usage | EnumerationManagementService | |
getEnumeratedValues validateEnumeratedValue updateEnumeratedValue addEnumeratedValue | ||
Type | Complex |
ShortName | Name | Type | Description | Required? | Read only? | Cardinality | XML Attribute? | Implementation Notes |
---|---|---|---|---|---|---|---|---|
code | Code | String | Typically coincides with a code representation. Likely the key if this is a reference to another object. |
One | No | |||
abbrevValue | Abbrev Value | String | Typically coincides with a shortened name. May be equal to the code or value fields. |
One | No | |||
value | Value | String | Typically coincides with a name for display. | One | No | |||
sortKey | Sort Key | String | Default position for the enumerated value. This might or might not exist, particularly in cases where the enumeration consists solely of a view. |
One | No | |||
contexts | Contexts | EnumContextValueInfoList | Indicates which context types and values this particular enumerated value participates in. |
Many | No | |||
enumerationKey | Enumeration Key | String | Identifier for the enumeration | One | Yes | |||
effectiveDate | Effective Date | Date | Date/time this object became effective. Must be less than or equal to the expirationDate specified. |
One | No | |||
expirationDate | Expiration Date | Date | Date/time this relationship is no longer effective. Must be greater than or equal to the effectiveDate specified. |
One | No | |||
meta | Meta | Meta | Create and last update info for the structure. This is optional and treated as read only since the data is set by the internals of the service during maintenance operations. Contains audit trail information about the creation and last update of this object Also contains the version ind used for optimistic locking. Attempts to set or update should result in a ReadOnlyException being thrown. |
Required on updates | Read only | One | No |