Enum EditableType
- java.lang.Object
-
- java.lang.Enum<EditableType>
-
- com.redwood.scheduler.api.model.enumeration.EditableType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<EditableType,Character>
,SchedulerEnumeration<EditableType>
,Serializable
,Comparable<EditableType>
public enum EditableType extends Enum<EditableType> implements SchedulerEnumeration<EditableType>
Deprecated Class, do not use. (not used): When is the parameter editable? (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Always
Deprecated.Use of this class is deprecated.Never
Deprecated.Use of this class is deprecated.OnlyIfNull
Deprecated.Use of this class is deprecated.
-
Field Summary
Fields Modifier and Type Field Description static char
AlwaysCode
Deprecated.static char
NeverCode
Deprecated.static char
OnlyIfNullCode
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description char
getCodeEx()
Get the code that is used to represent this enumeration in the database.Character
getCodeExCharacter()
Get the code that is used to represent this enumeration in the database.String
getCodeExString()
Get the code that is used to represent this enumeration in the database.Character
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.static EditableType
safeValueOf(String value)
Helper function to return the EditableType represented byvalue
.static EditableType
valueOf(char code)
Helper function to return the EditableType represented by code.static EditableType
valueOf(Character code)
Helper function to return the EditableType represented by code.static EditableType
valueOf(String name)
Returns the enum constant of this type with the specified name.static EditableType
valueOfCode(String code)
Helper function to return the EditableType represented by code.static EditableType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.-
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration
name, ordinal
-
Methods inherited from interface java.lang.Comparable
compareTo
-
-
-
-
Enum Constant Detail
-
Always
@Deprecated public static final EditableType Always
Deprecated.Use of this class is deprecated. This was never used in the product, you should useValueEditable
instead.Deprecated Class, do not use. (not used):The Parameter is always editable.
-
OnlyIfNull
@Deprecated public static final EditableType OnlyIfNull
Deprecated.Use of this class is deprecated. This was never used in the product, you should useValueEditable
instead.Deprecated Class, do not use. (not used):The Parameter is only editable if the default expression returns null.
-
Never
@Deprecated public static final EditableType Never
Deprecated.Use of this class is deprecated. This was never used in the product, you should useValueEditable
instead.Deprecated Class, do not use. (not used):The Parameter is never editable.
-
-
Field Detail
-
AlwaysCode
@Deprecated public static final char AlwaysCode
Deprecated.The char returned from Always.getCodeEx().
-
OnlyIfNullCode
@Deprecated public static final char OnlyIfNullCode
Deprecated.The char returned from OnlyIfNull.getCodeEx().
-
NeverCode
@Deprecated public static final char NeverCode
Deprecated.The char returned from Never.getCodeEx().
-
-
Method Detail
-
values
public static EditableType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (EditableType c : EditableType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static EditableType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
valueOfCode
public static EditableType valueOfCode(String code)
Helper function to return the EditableType represented by code. code must be a single character. If code is null, longer than one character, empty, or not a valid code then this method will return null.- Parameters:
code
- A string with one character that is one of the codes for EditableType- Returns:
- The EditableType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static EditableType safeValueOf(String value)
Helper function to return the EditableType represented byvalue
. Ifvalue
is null, or not a valid EditableType enumeration then this method will return null.The main difference between this method and
valueOf(String)
, is that this method will return null when passed an invalidvalue
,valueOf(String)
will throw anIllegalArgumentException
.- Parameters:
value
- The string value that corresponds to the requested enumeration value- Returns:
- The EditableType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static EditableType valueOf(Character code)
Helper function to return the EditableType represented by code. If code is null, or not a valid EditableType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The EditableType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static EditableType valueOf(char code)
Helper function to return the EditableType represented by code. If code is not a valid EditableType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The EditableType corresponding to code, or null, if code is not a valid code
-
getCodeEx
public char getCodeEx()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeEx
in interfaceSchedulerEnumeration<EditableType>
- Returns:
- the database code for the enumeration
-
getCodeExValue
public Character getCodeExValue()
Description copied from interface:BaseSchedulerEnumeration
Return the code for the enumeration item as the database type of this enumeration.- Specified by:
getCodeExValue
in interfaceBaseSchedulerEnumeration<EditableType,Character>
- Returns:
- the enumeration code
-
getCodeExCharacter
public Character getCodeExCharacter()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExCharacter
in interfaceSchedulerEnumeration<EditableType>
- Returns:
- the database code for the enumeration
-
getTranslationKey
public String getTranslationKey()
Description copied from interface:BaseSchedulerEnumeration
Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.- Specified by:
getTranslationKey
in interfaceBaseSchedulerEnumeration<EditableType,Character>
- Returns:
- the key.
-
getTranslationEN
public String getTranslationEN()
Description copied from interface:BaseSchedulerEnumeration
Get the English name of this enumeration.- Specified by:
getTranslationEN
in interfaceBaseSchedulerEnumeration<EditableType,Character>
- Returns:
- the English name of this enumeration.
-
getDescriptionKey
public String getDescriptionKey()
Description copied from interface:BaseSchedulerEnumeration
Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.- Specified by:
getDescriptionKey
in interfaceBaseSchedulerEnumeration<EditableType,Character>
- Returns:
- the key that can be passed to
SchedulerSession.translateField(String)
to retrieve the translated description.
-
getCodeExString
public String getCodeExString()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExString
in interfaceSchedulerEnumeration<EditableType>
- Returns:
- the database code for the enumeration
-
-