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

Enum AlertingBehavior

java.lang.Object

java.lang.Enum<AlertingBehavior>

com.redwood.scheduler.api.model.enumeration.AlertingBehavior

All Implemented Interfaces:

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

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

This will allow the user to determine alerting behaviour within a chain (Character Enumeration)

Enum Constant Summary

Enum Constants

Enum Constant	Description
ChainAndJobs	Chain and Processes
ChainAndSteps	Chain and Steps
ChainOnly	Chain Only
ChainStepsAndJobs	Chain, Steps and Processes
JobsOnly	Processes Only
Standard	Standard
StepsAndJobs	Steps and Processes
StepsOnly	Steps Only

Field Summary

Fields

Modifier and Type	Field	Description
static char	ChainAndJobsCode	The char returned from ChainAndJobs.getCodeEx().
static char	ChainAndStepsCode	The char returned from ChainAndSteps.getCodeEx().
static char	ChainOnlyCode	The char returned from ChainOnly.getCodeEx().
static char	ChainStepsAndJobsCode	The char returned from ChainStepsAndJobs.getCodeEx().
static char	JobsOnlyCode	The char returned from JobsOnly.getCodeEx().
static char	StandardCode	The char returned from Standard.getCodeEx().
static char	StepsAndJobsCode	The char returned from StepsAndJobs.getCodeEx().
static char	StepsOnlyCode	The char returned from StepsOnly.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.
static AlertingBehavior	safeValueOf(String value)	Helper function to return the AlertingBehavior represented by value.
static AlertingBehavior	valueOf(char code)	Helper function to return the AlertingBehavior represented by code.
static AlertingBehavior	valueOf(Character code)	Helper function to return the AlertingBehavior represented by code.
static AlertingBehavior	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AlertingBehavior	valueOfCode(String code)	Helper function to return the AlertingBehavior represented by code.
static AlertingBehavior[]	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

Standard

public static final AlertingBehavior Standard

Standard

ChainOnly

public static final AlertingBehavior ChainOnly

Chain Only

StepsOnly

public static final AlertingBehavior StepsOnly

Steps Only

ChainAndSteps

public static final AlertingBehavior ChainAndSteps

Chain and Steps

JobsOnly

public static final AlertingBehavior JobsOnly

Processes Only

ChainAndJobs

public static final AlertingBehavior ChainAndJobs

Chain and Processes

StepsAndJobs

public static final AlertingBehavior StepsAndJobs

Steps and Processes

ChainStepsAndJobs

public static final AlertingBehavior ChainStepsAndJobs

Chain, Steps and Processes

Field Detail

StandardCode

public static final char StandardCode

The char returned from Standard.getCodeEx().

See Also:

Standard, Constant Field Values

ChainOnlyCode

public static final char ChainOnlyCode

The char returned from ChainOnly.getCodeEx().

See Also:

ChainOnly, Constant Field Values

StepsOnlyCode

public static final char StepsOnlyCode

The char returned from StepsOnly.getCodeEx().

See Also:

StepsOnly, Constant Field Values

ChainAndStepsCode

public static final char ChainAndStepsCode

The char returned from ChainAndSteps.getCodeEx().

See Also:

ChainAndSteps, Constant Field Values

JobsOnlyCode

public static final char JobsOnlyCode

The char returned from JobsOnly.getCodeEx().

See Also:

JobsOnly, Constant Field Values

ChainAndJobsCode

public static final char ChainAndJobsCode

The char returned from ChainAndJobs.getCodeEx().

See Also:

ChainAndJobs, Constant Field Values

StepsAndJobsCode

public static final char StepsAndJobsCode

The char returned from StepsAndJobs.getCodeEx().

See Also:

StepsAndJobs, Constant Field Values

ChainStepsAndJobsCode

public static final char ChainStepsAndJobsCode

The char returned from ChainStepsAndJobs.getCodeEx().

See Also:

ChainStepsAndJobs, Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

valueOfCode

public static AlertingBehavior valueOfCode(String code)

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

Returns:

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

safeValueOf

public static AlertingBehavior safeValueOf(String value)

Helper function to return the AlertingBehavior represented by value. If value is null, or not a valid AlertingBehavior 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 AlertingBehavior corresponding to value, or null, if value is null, or not a valid enumeration

See Also:

valueOf(String)

valueOf

public static AlertingBehavior valueOf(Character code)

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

Parameters:

code - Character that is one of the codes for HandlerAction

Returns:

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

valueOf

public static AlertingBehavior valueOf(char code)

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

Parameters:

code - char that is one of the codes for HandlerAction

Returns:

The AlertingBehavior 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<AlertingBehavior>

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<AlertingBehavior,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<AlertingBehavior>

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<AlertingBehavior,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<AlertingBehavior,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<AlertingBehavior,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<AlertingBehavior>

Returns:

the database code for the enumeration