Package com.redwood.scheduler.api.model.enumeration

Enum JobDefinitionAlertSourceParameterMatchType

java.lang.Object

java.lang.Enum<JobDefinitionAlertSourceParameterMatchType>

com.redwood.scheduler.api.model.enumeration.JobDefinitionAlertSourceParameterMatchType

All Implemented Interfaces:

BaseSchedulerEnumeration<JobDefinitionAlertSourceParameterMatchType,Character>, SchedulerEnumeration<JobDefinitionAlertSourceParameterMatchType>, Serializable, Comparable<JobDefinitionAlertSourceParameterMatchType>

public enum JobDefinitionAlertSourceParameterMatchType
extends Enum<JobDefinitionAlertSourceParameterMatchType>
implements SchedulerEnumeration<JobDefinitionAlertSourceParameterMatchType>

Type of match for ia job definition alert source parameter match. (Character Enumeration)

Enum Constant Summary

Enum Constants

Enum Constant	Description
ExactInsensitive	Exact (case insensitive)
ExactSensitive	Exact (case sensitive).
GlobInsensitive	Pattern using ? and * (case insensitive)
GlobSensitive	Pattern using ? and * (case sensitive)
RegexInsensitive	Pattern using ? and * (case insensitive)
RegexSensitive	Pattern using ? and * (case sensitive)

Field Summary

Fields

Modifier and Type	Field	Description
static char	ExactInsensitiveCode	The char returned from ExactInsensitive.getCodeEx().
static char	ExactSensitiveCode	The char returned from ExactSensitive.getCodeEx().
static char	GlobInsensitiveCode	The char returned from GlobInsensitive.getCodeEx().
static char	GlobSensitiveCode	The char returned from GlobSensitive.getCodeEx().
static char	RegexInsensitiveCode	The char returned from RegexInsensitive.getCodeEx().
static char	RegexSensitiveCode	The char returned from RegexSensitive.getCodeEx().

Method Summary

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.
boolean	isCaseSensitive()
static JobDefinitionAlertSourceParameterMatchType	safeValueOf(String value)	Helper function to return the JobDefinitionAlertSourceParameterMatchType represented by value.
static JobDefinitionAlertSourceParameterMatchType	valueOf(char code)	Helper function to return the JobDefinitionAlertSourceParameterMatchType represented by code.
static JobDefinitionAlertSourceParameterMatchType	valueOf(Character code)	Helper function to return the JobDefinitionAlertSourceParameterMatchType represented by code.
static JobDefinitionAlertSourceParameterMatchType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static JobDefinitionAlertSourceParameterMatchType	valueOfCode(String code)	Helper function to return the JobDefinitionAlertSourceParameterMatchType represented by code.
static JobDefinitionAlertSourceParameterMatchType[]	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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration

name, ordinal

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Detail

ExactInsensitive

public static final JobDefinitionAlertSourceParameterMatchType ExactInsensitive

Exact (case insensitive)

ExactSensitive

public static final JobDefinitionAlertSourceParameterMatchType ExactSensitive

Exact (case sensitive).

GlobInsensitive

public static final JobDefinitionAlertSourceParameterMatchType GlobInsensitive

Pattern using ? and * (case insensitive)

GlobSensitive

public static final JobDefinitionAlertSourceParameterMatchType GlobSensitive

Pattern using ? and * (case sensitive)

RegexInsensitive

public static final JobDefinitionAlertSourceParameterMatchType RegexInsensitive

Pattern using ? and * (case insensitive)

RegexSensitive

public static final JobDefinitionAlertSourceParameterMatchType RegexSensitive

Pattern using ? and * (case sensitive)

Field Detail

ExactInsensitiveCode

public static final char ExactInsensitiveCode

The char returned from ExactInsensitive.getCodeEx().

See Also:

ExactInsensitive, Constant Field Values

ExactSensitiveCode

public static final char ExactSensitiveCode

The char returned from ExactSensitive.getCodeEx().

See Also:

ExactSensitive, Constant Field Values

GlobInsensitiveCode

public static final char GlobInsensitiveCode

The char returned from GlobInsensitive.getCodeEx().

See Also:

GlobInsensitive, Constant Field Values

GlobSensitiveCode

public static final char GlobSensitiveCode

The char returned from GlobSensitive.getCodeEx().

See Also:

GlobSensitive, Constant Field Values

RegexInsensitiveCode

public static final char RegexInsensitiveCode

The char returned from RegexInsensitive.getCodeEx().

See Also:

RegexInsensitive, Constant Field Values

RegexSensitiveCode

public static final char RegexSensitiveCode

The char returned from RegexSensitive.getCodeEx().

See Also:

RegexSensitive, Constant Field Values

Method Detail

values

public static JobDefinitionAlertSourceParameterMatchType[] 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 (JobDefinitionAlertSourceParameterMatchType c : JobDefinitionAlertSourceParameterMatchType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JobDefinitionAlertSourceParameterMatchType 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

isCaseSensitive

public boolean isCaseSensitive()

valueOfCode

public static JobDefinitionAlertSourceParameterMatchType valueOfCode(String code)

Helper function to return the JobDefinitionAlertSourceParameterMatchType 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 JobDefinitionAlertSourceParameterMatchType

Returns:

The JobDefinitionAlertSourceParameterMatchType corresponding to code, or null, if code is null, longer than one character, or not a valid code

safeValueOf

public static JobDefinitionAlertSourceParameterMatchType safeValueOf(String value)

Helper function to return the JobDefinitionAlertSourceParameterMatchType represented by value. If value is null, or not a valid JobDefinitionAlertSourceParameterMatchType 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 invalid value, valueOf(String) will throw an IllegalArgumentException.

Parameters:

value - The string value that corresponds to the requested enumeration value

Returns:

The JobDefinitionAlertSourceParameterMatchType corresponding to value, or null, if value is null, or not a valid enumeration

See Also:

valueOf(String)

valueOf

public static JobDefinitionAlertSourceParameterMatchType valueOf(Character code)

Helper function to return the JobDefinitionAlertSourceParameterMatchType represented by code. If code is null, or not a valid JobDefinitionAlertSourceParameterMatchType code then this method will return null.

Parameters:

code - Character that is one of the codes for HandlerAction

Returns:

The JobDefinitionAlertSourceParameterMatchType corresponding to code, or null, if code is null, or not a valid code

valueOf

public static JobDefinitionAlertSourceParameterMatchType valueOf(char code)

Helper function to return the JobDefinitionAlertSourceParameterMatchType represented by code. If code is not a valid JobDefinitionAlertSourceParameterMatchType code then this method will return null.

Parameters:

code - char that is one of the codes for HandlerAction

Returns:

The JobDefinitionAlertSourceParameterMatchType 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 interface SchedulerEnumeration<JobDefinitionAlertSourceParameterMatchType>

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 interface BaseSchedulerEnumeration<JobDefinitionAlertSourceParameterMatchType,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 interface SchedulerEnumeration<JobDefinitionAlertSourceParameterMatchType>

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 interface BaseSchedulerEnumeration<JobDefinitionAlertSourceParameterMatchType,Character>

Returns:

the key.

getTranslationEN

public String getTranslationEN()

Description copied from interface: BaseSchedulerEnumeration

Get the English name of this enumeration.

Specified by:

getTranslationEN in interface BaseSchedulerEnumeration<JobDefinitionAlertSourceParameterMatchType,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 interface BaseSchedulerEnumeration<JobDefinitionAlertSourceParameterMatchType,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 interface SchedulerEnumeration<JobDefinitionAlertSourceParameterMatchType>

Returns:

the database code for the enumeration