Interface BaseSchedulerEnumeration<E extends Comparable<E>,D>
-
- Type Parameters:
E
- The type of the enumerationD
- The type of data that is stored in the database for this enumeration type
- All Superinterfaces:
Comparable<E>
,Serializable
- All Known Subinterfaces:
SchedulerEnumeration<E>
,SchedulerIntegerEnumeration<E>
public interface BaseSchedulerEnumeration<E extends Comparable<E>,D> extends Comparable<E>, Serializable
Super interface of all generated enumeration types.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description D
getCodeExValue()
Return the code for the enumeration item as the database type of this enumeration.String
getDescriptionKey()
Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.String
getTranslationEN()
Get the English name of this enumeration.String
getTranslationKey()
Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.String
name()
Returns thename
of this enumeration.int
ordinal()
Return the defined position of the enumeration in it's list.-
Methods inherited from interface java.lang.Comparable
compareTo
-
-
-
-
Method Detail
-
name
String name()
Returns thename
of this enumeration.- Returns:
- the name of this enumeration
-
ordinal
int ordinal()
Return the defined position of the enumeration in it's list.- Returns:
- the ordinal position of the enumeration
-
getCodeExValue
D getCodeExValue()
Return the code for the enumeration item as the database type of this enumeration.- Returns:
- the enumeration code
-
getTranslationKey
String getTranslationKey()
Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.- Returns:
- the key.
-
getTranslationEN
String getTranslationEN()
Get the English name of this enumeration.- Returns:
- the English name of this enumeration.
-
getDescriptionKey
String getDescriptionKey()
Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.- Returns:
- the key that can be passed to
SchedulerSession.translateField(String)
to retrieve the translated description.
-
-