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 SummaryEnum Constants Enum Constant Description EqualToEqualsGreaterThanIs greater thanGreaterThanOrEqualToIs greater than or equal toInRangeIs in a rangeLessThanIs less thanLessThanOrEqualToIs less than or equal toMatchesRegexMatches a regular expressionNotEqualToDoes not equalNotInRangeIs not in a rangeNotMatchesRegexDoes not match a regular expression
 - 
Field SummaryFields Modifier and Type Field Description static charEqualToCodeThe char returned from EqualTo.getCodeEx().static charGreaterThanCodeThe char returned from GreaterThan.getCodeEx().static charGreaterThanOrEqualToCodeThe char returned from GreaterThanOrEqualTo.getCodeEx().static charInRangeCodeThe char returned from InRange.getCodeEx().static charLessThanCodeThe char returned from LessThan.getCodeEx().static charLessThanOrEqualToCodeThe char returned from LessThanOrEqualTo.getCodeEx().static charMatchesRegexCodeThe char returned from MatchesRegex.getCodeEx().static charNotEqualToCodeThe char returned from NotEqualTo.getCodeEx().static charNotInRangeCodeThe char returned from NotInRange.getCodeEx().static charNotMatchesRegexCodeThe char returned from NotMatchesRegex.getCodeEx().
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetBaseOperation()chargetCodeEx()Get the code that is used to represent this enumeration in the database.CharactergetCodeExCharacter()Get the code that is used to represent this enumeration in the database.StringgetCodeExString()Get the code that is used to represent this enumeration in the database.CharactergetCodeExValue()Return the code for the enumeration item as the database type of this enumeration.StringgetDescriptionKey()Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.StringgetTranslationEN()Get the English name of this enumeration.StringgetTranslationKey()Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.booleanisNegate()static ReportSelectionOperationsafeValueOf(String value)Helper function to return the ReportSelectionOperation represented byvalue.static ReportSelectionOperationvalueOf(char code)Helper function to return the ReportSelectionOperation represented by code.static ReportSelectionOperationvalueOf(Character code)Helper function to return the ReportSelectionOperation represented by code.static ReportSelectionOperationvalueOf(String name)Returns the enum constant of this type with the specified name.static ReportSelectionOperationvalueOfCode(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.Enumclone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 - 
Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumerationname, ordinal
 - 
Methods inherited from interface java.lang.ComparablecompareTo
 
- 
 
- 
- 
- 
Enum Constant Detail- 
EqualTopublic static final ReportSelectionOperation EqualTo Equals
 - 
NotEqualTopublic static final ReportSelectionOperation NotEqualTo Does not equal
 - 
MatchesRegexpublic static final ReportSelectionOperation MatchesRegex Matches a regular expression
 - 
NotMatchesRegexpublic static final ReportSelectionOperation NotMatchesRegex Does not match a regular expression
 - 
InRangepublic static final ReportSelectionOperation InRange Is in a range
 - 
NotInRangepublic static final ReportSelectionOperation NotInRange Is not in a range
 - 
GreaterThanpublic static final ReportSelectionOperation GreaterThan Is greater than
 - 
LessThanpublic static final ReportSelectionOperation LessThan Is less than
 - 
GreaterThanOrEqualTopublic static final ReportSelectionOperation GreaterThanOrEqualTo Is greater than or equal to
 - 
LessThanOrEqualTopublic static final ReportSelectionOperation LessThanOrEqualTo Is less than or equal to
 
- 
 - 
Field Detail- 
EqualToCodepublic static final char EqualToCode The char returned from EqualTo.getCodeEx().- See Also:
- EqualTo, Constant Field Values
 
 - 
NotEqualToCodepublic static final char NotEqualToCode The char returned from NotEqualTo.getCodeEx().- See Also:
- NotEqualTo, Constant Field Values
 
 - 
MatchesRegexCodepublic static final char MatchesRegexCode The char returned from MatchesRegex.getCodeEx().- See Also:
- MatchesRegex, Constant Field Values
 
 - 
NotMatchesRegexCodepublic static final char NotMatchesRegexCode The char returned from NotMatchesRegex.getCodeEx().- See Also:
- NotMatchesRegex, Constant Field Values
 
 - 
InRangeCodepublic static final char InRangeCode The char returned from InRange.getCodeEx().- See Also:
- InRange, Constant Field Values
 
 - 
NotInRangeCodepublic static final char NotInRangeCode The char returned from NotInRange.getCodeEx().- See Also:
- NotInRange, Constant Field Values
 
 - 
GreaterThanCodepublic static final char GreaterThanCode The char returned from GreaterThan.getCodeEx().- See Also:
- GreaterThan, Constant Field Values
 
 - 
LessThanCodepublic static final char LessThanCode The char returned from LessThan.getCodeEx().- See Also:
- LessThan, Constant Field Values
 
 - 
GreaterThanOrEqualToCodepublic static final char GreaterThanOrEqualToCode The char returned from GreaterThanOrEqualTo.getCodeEx().- See Also:
- GreaterThanOrEqualTo, Constant Field Values
 
 - 
LessThanOrEqualToCodepublic static final char LessThanOrEqualToCode The char returned from LessThanOrEqualTo.getCodeEx().- See Also:
- LessThanOrEqualTo, Constant Field Values
 
 
- 
 - 
Method Detail- 
valuespublic 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
 
 - 
valueOfpublic 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 name
- NullPointerException- if the argument is null
 
 - 
isNegatepublic boolean isNegate() 
 - 
getBaseOperationpublic String getBaseOperation() 
 - 
valueOfCodepublic 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
 
 - 
safeValueOfpublic static ReportSelectionOperation safeValueOf(String value) Helper function to return the ReportSelectionOperation represented byvalue. Ifvalueis 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, ifvalueis null, or not a valid enumeration
- See Also:
- valueOf(String)
 
 - 
valueOfpublic 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
 
 - 
valueOfpublic 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
 
 - 
getCodeExpublic char getCodeEx() Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
- getCodeExin interface- SchedulerEnumeration<ReportSelectionOperation>
- Returns:
- the database code for the enumeration
 
 - 
getCodeExValuepublic Character getCodeExValue() Description copied from interface:BaseSchedulerEnumerationReturn the code for the enumeration item as the database type of this enumeration.- Specified by:
- getCodeExValuein interface- BaseSchedulerEnumeration<ReportSelectionOperation,Character>
- Returns:
- the enumeration code
 
 - 
getCodeExCharacterpublic Character getCodeExCharacter() Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
- getCodeExCharacterin interface- SchedulerEnumeration<ReportSelectionOperation>
- Returns:
- the database code for the enumeration
 
 - 
getTranslationKeypublic String getTranslationKey() Description copied from interface:BaseSchedulerEnumerationGet the translation-key that must be used to retrieve the locale-specific name of this enumeration.- Specified by:
- getTranslationKeyin interface- BaseSchedulerEnumeration<ReportSelectionOperation,Character>
- Returns:
- the key.
 
 - 
getTranslationENpublic String getTranslationEN() Description copied from interface:BaseSchedulerEnumerationGet the English name of this enumeration.- Specified by:
- getTranslationENin interface- BaseSchedulerEnumeration<ReportSelectionOperation,Character>
- Returns:
- the English name of this enumeration.
 
 - 
getDescriptionKeypublic String getDescriptionKey() Description copied from interface:BaseSchedulerEnumerationGet the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.- Specified by:
- getDescriptionKeyin interface- BaseSchedulerEnumeration<ReportSelectionOperation,Character>
- Returns:
- the key that can be passed to
         SchedulerSession.translateField(String)to retrieve the translated description.
 
 - 
getCodeExStringpublic String getCodeExString() Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
- getCodeExStringin interface- SchedulerEnumeration<ReportSelectionOperation>
- Returns:
- the database code for the enumeration
 
 
- 
 
-