com.genesyslab.ail
Interface Enumerator

All Superinterfaces:
IdObject

public interface Enumerator
extends IdObject

An Enumerator object, defined in the Configuration Layer.


Nested Class Summary
static class Enumerator.Type
          Constants for the different enumerator types.
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.IdObject
IdObject.ObjectType
 
Method Summary
 EnumValue getDefaultValue()
          Returns the default value of this enumerator, or null if no value is defined as default.
 java.lang.String getDescription()
          Returns the description of this enumerator.
 java.lang.String getDisplayName()
          Returns the display name of this enumerator.
 java.lang.String getId()
          Returns the name of this enumerator.
 Enumerator.Type getType()
          Returns the type of this enumerator.
 java.util.Collection getValues()
          Returns the values of this Enumerator.
 
Methods inherited from interface com.genesyslab.ail.IdObject
getObjectType
 

Method Detail

getId

java.lang.String getId()
Returns the name of this enumerator.

Specified by:
getId in interface IdObject

getType

Enumerator.Type getType()
Returns the type of this enumerator. It can be null if no type is defined.


getDescription

java.lang.String getDescription()
Returns the description of this enumerator.


getDisplayName

java.lang.String getDisplayName()
Returns the display name of this enumerator.


getValues

java.util.Collection getValues()
Returns the values of this Enumerator.

Returns:
a Collection of EnumValues

getDefaultValue

EnumValue getDefaultValue()
Returns the default value of this enumerator, or null if no value is defined as default.