Enum QueryConditionType
- java.lang.Object
-
- java.lang.Enum<QueryConditionType>
-
- com.redwood.scheduler.api.model.enumeration.QueryConditionType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<QueryConditionType,Character>
,SchedulerEnumeration<QueryConditionType>
,Serializable
,Comparable<QueryConditionType>
public enum QueryConditionType extends Enum<QueryConditionType> implements SchedulerEnumeration<QueryConditionType>
(Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CustomSQL
The given value is a custom SQL WHERE clause.DateCompare
The date must not be older or newer (depending on BEFORE or AFTER) then now plus the value in the query condition value, which can be negative.IntegerCompare
The value is compared with the value in queryconditionvalue 2, the type of comparison is in query condition value 1, which can be <, = or > (less than, equals or greater than)IntelliSearchCompare
Persisted wrapped IntelliSearchNowTimeCompare
Pass it an integer between 0 and 24 and it will compareNull
Compare field to null.ObjectCompare
Does the field point to any of theStringCompare
Does field contain value
-
Field Summary
Fields Modifier and Type Field Description static char
CustomSQLCode
The char returned from CustomSQL.getCodeEx().static char
DateCompareCode
The char returned from DateCompare.getCodeEx().static char
IntegerCompareCode
The char returned from IntegerCompare.getCodeEx().static char
IntelliSearchCompareCode
The char returned from IntelliSearchCompare.getCodeEx().static char
NowTimeCompareCode
The char returned from NowTimeCompare.getCodeEx().static char
NullCode
The char returned from Null.getCodeEx().static char
ObjectCompareCode
The char returned from ObjectCompare.getCodeEx().static char
StringCompareCode
The char returned from StringCompare.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 QueryConditionType
safeValueOf(String value)
Helper function to return the QueryConditionType represented byvalue
.static QueryConditionType
valueOf(char code)
Helper function to return the QueryConditionType represented by code.static QueryConditionType
valueOf(Character code)
Helper function to return the QueryConditionType represented by code.static QueryConditionType
valueOf(String name)
Returns the enum constant of this type with the specified name.static QueryConditionType
valueOfCode(String code)
Helper function to return the QueryConditionType represented by code.static QueryConditionType[]
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
-
CustomSQL
public static final QueryConditionType CustomSQL
The given value is a custom SQL WHERE clause.
-
DateCompare
public static final QueryConditionType DateCompare
The date must not be older or newer (depending on BEFORE or AFTER) then now plus the value in the query condition value, which can be negative.
-
IntegerCompare
public static final QueryConditionType IntegerCompare
The value is compared with the value in queryconditionvalue 2, the type of comparison is in query condition value 1, which can be <, = or > (less than, equals or greater than)
-
Null
public static final QueryConditionType Null
Compare field to null.
-
ObjectCompare
public static final QueryConditionType ObjectCompare
Does the field point to any of the
-
StringCompare
public static final QueryConditionType StringCompare
Does field contain value
-
IntelliSearchCompare
public static final QueryConditionType IntelliSearchCompare
Persisted wrapped IntelliSearch
-
NowTimeCompare
public static final QueryConditionType NowTimeCompare
Pass it an integer between 0 and 24 and it will compare
-
-
Field Detail
-
CustomSQLCode
public static final char CustomSQLCode
The char returned from CustomSQL.getCodeEx().- See Also:
CustomSQL
, Constant Field Values
-
DateCompareCode
public static final char DateCompareCode
The char returned from DateCompare.getCodeEx().- See Also:
DateCompare
, Constant Field Values
-
IntegerCompareCode
public static final char IntegerCompareCode
The char returned from IntegerCompare.getCodeEx().- See Also:
IntegerCompare
, Constant Field Values
-
NullCode
public static final char NullCode
The char returned from Null.getCodeEx().- See Also:
Null
, Constant Field Values
-
ObjectCompareCode
public static final char ObjectCompareCode
The char returned from ObjectCompare.getCodeEx().- See Also:
ObjectCompare
, Constant Field Values
-
StringCompareCode
public static final char StringCompareCode
The char returned from StringCompare.getCodeEx().- See Also:
StringCompare
, Constant Field Values
-
IntelliSearchCompareCode
public static final char IntelliSearchCompareCode
The char returned from IntelliSearchCompare.getCodeEx().- See Also:
IntelliSearchCompare
, Constant Field Values
-
NowTimeCompareCode
public static final char NowTimeCompareCode
The char returned from NowTimeCompare.getCodeEx().- See Also:
NowTimeCompare
, Constant Field Values
-
-
Method Detail
-
values
public static QueryConditionType[] 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 (QueryConditionType c : QueryConditionType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static QueryConditionType 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 QueryConditionType valueOfCode(String code)
Helper function to return the QueryConditionType 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 QueryConditionType- Returns:
- The QueryConditionType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static QueryConditionType safeValueOf(String value)
Helper function to return the QueryConditionType represented byvalue
. Ifvalue
is null, or not a valid QueryConditionType 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 QueryConditionType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static QueryConditionType valueOf(Character code)
Helper function to return the QueryConditionType represented by code. If code is null, or not a valid QueryConditionType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The QueryConditionType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static QueryConditionType valueOf(char code)
Helper function to return the QueryConditionType represented by code. If code is not a valid QueryConditionType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The QueryConditionType 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<QueryConditionType>
- 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<QueryConditionType,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<QueryConditionType>
- 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<QueryConditionType,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<QueryConditionType,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<QueryConditionType,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<QueryConditionType>
- Returns:
- the database code for the enumeration
-
-