Enum ObjectSearchOperatorType
- java.lang.Object
-
- java.lang.Enum<ObjectSearchOperatorType>
-
- com.redwood.scheduler.api.model.enumeration.ObjectSearchOperatorType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<ObjectSearchOperatorType,Character>
,SchedulerEnumeration<ObjectSearchOperatorType>
,Serializable
,Comparable<ObjectSearchOperatorType>
public enum ObjectSearchOperatorType extends Enum<ObjectSearchOperatorType> implements SchedulerEnumeration<ObjectSearchOperatorType>
The operator type for Object Search queries. (Character Enumeration)
-
-
Field Summary
Fields Modifier and Type Field Description static char
EqualsCode
The char returned from Equals.getCodeEx().static char
LikeCode
The char returned from Like.getCodeEx().static char
NotEqualsCode
The char returned from NotEquals.getCodeEx().static char
NotLikeCode
The char returned from NotLike.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 ObjectSearchOperatorType
safeValueOf(String value)
Helper function to return the ObjectSearchOperatorType represented byvalue
.static ObjectSearchOperatorType
valueOf(char code)
Helper function to return the ObjectSearchOperatorType represented by code.static ObjectSearchOperatorType
valueOf(Character code)
Helper function to return the ObjectSearchOperatorType represented by code.static ObjectSearchOperatorType
valueOf(String name)
Returns the enum constant of this type with the specified name.static ObjectSearchOperatorType
valueOfCode(String code)
Helper function to return the ObjectSearchOperatorType represented by code.static ObjectSearchOperatorType[]
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
-
Equals
public static final ObjectSearchOperatorType Equals
The result is equal to the search value
-
NotEquals
public static final ObjectSearchOperatorType NotEquals
The result is not equal to the search value
-
Like
public static final ObjectSearchOperatorType Like
The result is like (contains) the search value
-
NotLike
public static final ObjectSearchOperatorType NotLike
The result is not like (does not contain) the search value
-
-
Field Detail
-
EqualsCode
public static final char EqualsCode
The char returned from Equals.getCodeEx().- See Also:
Equals
, Constant Field Values
-
NotEqualsCode
public static final char NotEqualsCode
The char returned from NotEquals.getCodeEx().- See Also:
NotEquals
, Constant Field Values
-
LikeCode
public static final char LikeCode
The char returned from Like.getCodeEx().- See Also:
Like
, Constant Field Values
-
NotLikeCode
public static final char NotLikeCode
The char returned from NotLike.getCodeEx().- See Also:
NotLike
, Constant Field Values
-
-
Method Detail
-
values
public static ObjectSearchOperatorType[] 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 (ObjectSearchOperatorType c : ObjectSearchOperatorType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ObjectSearchOperatorType 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 ObjectSearchOperatorType valueOfCode(String code)
Helper function to return the ObjectSearchOperatorType 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 ObjectSearchOperatorType- Returns:
- The ObjectSearchOperatorType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static ObjectSearchOperatorType safeValueOf(String value)
Helper function to return the ObjectSearchOperatorType represented byvalue
. Ifvalue
is null, or not a valid ObjectSearchOperatorType 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 ObjectSearchOperatorType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static ObjectSearchOperatorType valueOf(Character code)
Helper function to return the ObjectSearchOperatorType represented by code. If code is null, or not a valid ObjectSearchOperatorType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The ObjectSearchOperatorType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static ObjectSearchOperatorType valueOf(char code)
Helper function to return the ObjectSearchOperatorType represented by code. If code is not a valid ObjectSearchOperatorType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The ObjectSearchOperatorType 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<ObjectSearchOperatorType>
- 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<ObjectSearchOperatorType,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<ObjectSearchOperatorType>
- 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<ObjectSearchOperatorType,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<ObjectSearchOperatorType,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<ObjectSearchOperatorType,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<ObjectSearchOperatorType>
- Returns:
- the database code for the enumeration
-
-