Enum ReportSelectionOperation
- java.lang.Object
-
- java.lang.Enum<ReportSelectionOperation>
-
- com.redwood.scheduler.api.model.enumeration.ReportSelectionOperation
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<ReportSelectionOperation,Character>
,SchedulerEnumeration<ReportSelectionOperation>
,Serializable
,Comparable<ReportSelectionOperation>
public enum ReportSelectionOperation extends Enum<ReportSelectionOperation> implements SchedulerEnumeration<ReportSelectionOperation>
An operation for use in Report Selection rules. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description EqualTo
EqualsGreaterThan
Is greater thanGreaterThanOrEqualTo
Is greater than or equal toInRange
Is in a rangeLessThan
Is less thanLessThanOrEqualTo
Is less than or equal toMatchesRegex
Matches a regular expressionNotEqualTo
Does not equalNotInRange
Is not in a rangeNotMatchesRegex
Does not match a regular expression
-
Field Summary
Fields Modifier and Type Field Description static char
EqualToCode
The char returned from EqualTo.getCodeEx().static char
GreaterThanCode
The char returned from GreaterThan.getCodeEx().static char
GreaterThanOrEqualToCode
The char returned from GreaterThanOrEqualTo.getCodeEx().static char
InRangeCode
The char returned from InRange.getCodeEx().static char
LessThanCode
The char returned from LessThan.getCodeEx().static char
LessThanOrEqualToCode
The char returned from LessThanOrEqualTo.getCodeEx().static char
MatchesRegexCode
The char returned from MatchesRegex.getCodeEx().static char
NotEqualToCode
The char returned from NotEqualTo.getCodeEx().static char
NotInRangeCode
The char returned from NotInRange.getCodeEx().static char
NotMatchesRegexCode
The char returned from NotMatchesRegex.getCodeEx().
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getBaseOperation()
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.boolean
isNegate()
static ReportSelectionOperation
safeValueOf(String value)
Helper function to return the ReportSelectionOperation represented byvalue
.static ReportSelectionOperation
valueOf(char code)
Helper function to return the ReportSelectionOperation represented by code.static ReportSelectionOperation
valueOf(Character code)
Helper function to return the ReportSelectionOperation represented by code.static ReportSelectionOperation
valueOf(String name)
Returns the enum constant of this type with the specified name.static ReportSelectionOperation
valueOfCode(String code)
Helper function to return the ReportSelectionOperation represented by code.static ReportSelectionOperation[]
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
-
EqualTo
public static final ReportSelectionOperation EqualTo
Equals
-
NotEqualTo
public static final ReportSelectionOperation NotEqualTo
Does not equal
-
MatchesRegex
public static final ReportSelectionOperation MatchesRegex
Matches a regular expression
-
NotMatchesRegex
public static final ReportSelectionOperation NotMatchesRegex
Does not match a regular expression
-
InRange
public static final ReportSelectionOperation InRange
Is in a range
-
NotInRange
public static final ReportSelectionOperation NotInRange
Is not in a range
-
GreaterThan
public static final ReportSelectionOperation GreaterThan
Is greater than
-
LessThan
public static final ReportSelectionOperation LessThan
Is less than
-
GreaterThanOrEqualTo
public static final ReportSelectionOperation GreaterThanOrEqualTo
Is greater than or equal to
-
LessThanOrEqualTo
public static final ReportSelectionOperation LessThanOrEqualTo
Is less than or equal to
-
-
Field Detail
-
EqualToCode
public static final char EqualToCode
The char returned from EqualTo.getCodeEx().- See Also:
EqualTo
, Constant Field Values
-
NotEqualToCode
public static final char NotEqualToCode
The char returned from NotEqualTo.getCodeEx().- See Also:
NotEqualTo
, Constant Field Values
-
MatchesRegexCode
public static final char MatchesRegexCode
The char returned from MatchesRegex.getCodeEx().- See Also:
MatchesRegex
, Constant Field Values
-
NotMatchesRegexCode
public static final char NotMatchesRegexCode
The char returned from NotMatchesRegex.getCodeEx().- See Also:
NotMatchesRegex
, Constant Field Values
-
InRangeCode
public static final char InRangeCode
The char returned from InRange.getCodeEx().- See Also:
InRange
, Constant Field Values
-
NotInRangeCode
public static final char NotInRangeCode
The char returned from NotInRange.getCodeEx().- See Also:
NotInRange
, Constant Field Values
-
GreaterThanCode
public static final char GreaterThanCode
The char returned from GreaterThan.getCodeEx().- See Also:
GreaterThan
, Constant Field Values
-
LessThanCode
public static final char LessThanCode
The char returned from LessThan.getCodeEx().- See Also:
LessThan
, Constant Field Values
-
GreaterThanOrEqualToCode
public static final char GreaterThanOrEqualToCode
The char returned from GreaterThanOrEqualTo.getCodeEx().- See Also:
GreaterThanOrEqualTo
, Constant Field Values
-
LessThanOrEqualToCode
public static final char LessThanOrEqualToCode
The char returned from LessThanOrEqualTo.getCodeEx().- See Also:
LessThanOrEqualTo
, Constant Field Values
-
-
Method Detail
-
values
public static ReportSelectionOperation[] 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 (ReportSelectionOperation c : ReportSelectionOperation.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ReportSelectionOperation 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
-
isNegate
public boolean isNegate()
-
getBaseOperation
public String getBaseOperation()
-
valueOfCode
public static ReportSelectionOperation valueOfCode(String code)
Helper function to return the ReportSelectionOperation 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 ReportSelectionOperation- Returns:
- The ReportSelectionOperation corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static ReportSelectionOperation safeValueOf(String value)
Helper function to return the ReportSelectionOperation represented byvalue
. Ifvalue
is null, or not a valid ReportSelectionOperation 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 ReportSelectionOperation corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static ReportSelectionOperation valueOf(Character code)
Helper function to return the ReportSelectionOperation represented by code. If code is null, or not a valid ReportSelectionOperation code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The ReportSelectionOperation corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static ReportSelectionOperation valueOf(char code)
Helper function to return the ReportSelectionOperation represented by code. If code is not a valid ReportSelectionOperation code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The ReportSelectionOperation 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<ReportSelectionOperation>
- 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<ReportSelectionOperation,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<ReportSelectionOperation>
- 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<ReportSelectionOperation,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<ReportSelectionOperation,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<ReportSelectionOperation,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<ReportSelectionOperation>
- Returns:
- the database code for the enumeration
-
-