Element
|
Type
|
Description
|
EnumerationInfoProvider
|
java
|
The interface defines how to implement a custom dynamic enumeration provider. Instances of this are instantiated through reflection. Therefore a public no-arg constructor is required. Any exceptions thrown from the methods in this interface result in an empty enumeration.
|
EnumerationInfoManager
|
java
|
This interface defines the method that enumeration info providers can use to reset their cached enumerations.
|
EnumerationInfo
|
java
|
This class represents an enumeration. It contains both the properties of the enumeration as well as it's entries. This class is not thread safe and should not be modified after handing it off to other code.
|
EnumerationEntryInfo
|
java
|
This class represents an enumeration entry. It contains the properties of the enumeration entry. There is a unique name for each enumeration entry.
|
Property
|
Default Value
|
Possible Values
|
Required?
|
Description
|
EnumerationInfo.AUTO_SORT
|
Boolean.FALSE
|
Boolean.FALSE
Boolean.TRUE
|
no
|
If the EnumerationInfo.AUTO_SORT property is set to true, then the system automatically sorts the enumeration based on the localized display names of the entries. If it is set to false, then the system sorts the enumeration based on the relative sort order you assign to the entries. If two or more entries are given the same sort order, those entries are sorted relative to each other based on their display names. Entries without a sort order defined are sorted after all entries with a sort order defined.
|
EnumerationInfo.DEFAULT_LOCALE
|
System Locale
|
Any Locale
|
no
|
Indicates the locale which should be used as the fallback if the client requests the localized display information for an enumeration entry for a locale for which localizations are not available.
|
Property
|
Default Value
|
Possible Values
|
Required?
|
Description
|
EnumerationEntryInfo.SORT_ORDER
|
null
|
Any Integer
|
no
|
If the EnumerationInfo.AUTO_SORT property is set to false, the system sorts the enumeration based on the relative sort order you assign to the entries. If two or more entries are given the same sort order, those entries are sorted relative to each other based on their display names. Entries without a sort order defined are sorted after all entries with a sort order defined.
|
EnumerationEntryInfo.SELECTABLE
|
Boolean.TRUE
|
Boolean.TRUE
Boolean.FALSE
|
no
|
Indicates whether the entry should be selectable by the end user during edit operations.
|
EnumerationEntryInfo.DISPLAY_NAME
|
null
|
Any String
|
no
|
The display name for the enumeration entry for the indicated locale.
|