Enum SimpleConstraintType
- java.lang.Object
-
- java.lang.Enum<SimpleConstraintType>
-
- com.redwood.scheduler.api.model.enumeration.SimpleConstraintType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<SimpleConstraintType,Character>
,SchedulerEnumeration<SimpleConstraintType>
,Serializable
,Comparable<SimpleConstraintType>
public enum SimpleConstraintType extends Enum<SimpleConstraintType> implements SchedulerEnumeration<SimpleConstraintType>
The type of simple (single parameter) constraint. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Enumeration
Values from an EnumerationExpression
A REL expression.List
A comma separated list (eg.None
No simple constraint.PairList
A comma and equals separated list (eg.QueryFilter
Values from a filterTable
Values from a table
-
Field Summary
Fields Modifier and Type Field Description static char
EnumerationCode
The char returned from Enumeration.getCodeEx().static char
ExpressionCode
The char returned from Expression.getCodeEx().static char
ListCode
The char returned from List.getCodeEx().static char
NoneCode
The char returned from None.getCodeEx().static char
PairListCode
The char returned from PairList.getCodeEx().static char
QueryFilterCode
The char returned from QueryFilter.getCodeEx().static char
TableCode
The char returned from Table.getCodeEx().
-
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 SimpleConstraintType
safeValueOf(String value)
Helper function to return the SimpleConstraintType represented byvalue
.static SimpleConstraintType
valueOf(char code)
Helper function to return the SimpleConstraintType represented by code.static SimpleConstraintType
valueOf(Character code)
Helper function to return the SimpleConstraintType represented by code.static SimpleConstraintType
valueOf(String name)
Returns the enum constant of this type with the specified name.static SimpleConstraintType
valueOfCode(String code)
Helper function to return the SimpleConstraintType represented by code.static SimpleConstraintType[]
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
-
None
public static final SimpleConstraintType None
No simple constraint.
-
List
public static final SimpleConstraintType List
A comma separated list (eg. Yes,No).
-
PairList
public static final SimpleConstraintType PairList
A comma and equals separated list (eg. Y=Yes,N=No).
-
Enumeration
public static final SimpleConstraintType Enumeration
Values from an Enumeration
-
Expression
public static final SimpleConstraintType Expression
A REL expression.
-
Table
public static final SimpleConstraintType Table
Values from a table
-
QueryFilter
public static final SimpleConstraintType QueryFilter
Values from a filter
-
-
Field Detail
-
NoneCode
public static final char NoneCode
The char returned from None.getCodeEx().- See Also:
None
, Constant Field Values
-
ListCode
public static final char ListCode
The char returned from List.getCodeEx().- See Also:
List
, Constant Field Values
-
PairListCode
public static final char PairListCode
The char returned from PairList.getCodeEx().- See Also:
PairList
, Constant Field Values
-
EnumerationCode
public static final char EnumerationCode
The char returned from Enumeration.getCodeEx().- See Also:
Enumeration
, Constant Field Values
-
ExpressionCode
public static final char ExpressionCode
The char returned from Expression.getCodeEx().- See Also:
Expression
, Constant Field Values
-
TableCode
public static final char TableCode
The char returned from Table.getCodeEx().- See Also:
Table
, Constant Field Values
-
QueryFilterCode
public static final char QueryFilterCode
The char returned from QueryFilter.getCodeEx().- See Also:
QueryFilter
, Constant Field Values
-
-
Method Detail
-
values
public static SimpleConstraintType[] 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 (SimpleConstraintType c : SimpleConstraintType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SimpleConstraintType 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 SimpleConstraintType valueOfCode(String code)
Helper function to return the SimpleConstraintType 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 SimpleConstraintType- Returns:
- The SimpleConstraintType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static SimpleConstraintType safeValueOf(String value)
Helper function to return the SimpleConstraintType represented byvalue
. Ifvalue
is null, or not a valid SimpleConstraintType 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 SimpleConstraintType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static SimpleConstraintType valueOf(Character code)
Helper function to return the SimpleConstraintType represented by code. If code is null, or not a valid SimpleConstraintType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The SimpleConstraintType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static SimpleConstraintType valueOf(char code)
Helper function to return the SimpleConstraintType represented by code. If code is not a valid SimpleConstraintType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The SimpleConstraintType 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<SimpleConstraintType>
- 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<SimpleConstraintType,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<SimpleConstraintType>
- 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<SimpleConstraintType,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<SimpleConstraintType,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<SimpleConstraintType,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<SimpleConstraintType>
- Returns:
- the database code for the enumeration
-
-