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

Enum FinalStatusAction

java.lang.Object

java.lang.Enum<FinalStatusAction>

com.redwood.scheduler.api.model.enumeration.FinalStatusAction

All Implemented Interfaces:

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

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

(Character Enumeration)

Enum Constant Summary

Enum Constants

Enum Constant	Description
ContinueSubmitFrame	If a submit frame is used, submit a new process according to that.
RequestRestart	Request final status action from the console
Restart	Automatically restart the process, even if the processes RestartCount has reached zero
RestartFromError	Automatically restart the chain, starting at the step that ran into Error, Killed or Unknown
RestartNoResubmit	Automatically restart the process, unless the processes RestartCount has reached zero
StopSubmitFrame	If a submit frame is used, stop (preserve the final status code)

Field Summary

Fields

Modifier and Type	Field	Description
static char	ContinueSubmitFrameCode	The char returned from ContinueSubmitFrame.getCodeEx().
static char	RequestRestartCode	The char returned from RequestRestart.getCodeEx().
static char	RestartCode	The char returned from Restart.getCodeEx().
static char	RestartFromErrorCode	The char returned from RestartFromError.getCodeEx().
static char	RestartNoResubmitCode	The char returned from RestartNoResubmit.getCodeEx().
static char	StopSubmitFrameCode	The char returned from StopSubmitFrame.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 FinalStatusAction	safeValueOf(String value)	Helper function to return the FinalStatusAction represented by value.
static FinalStatusAction	valueOf(char code)	Helper function to return the FinalStatusAction represented by code.
static FinalStatusAction	valueOf(Character code)	Helper function to return the FinalStatusAction represented by code.
static FinalStatusAction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FinalStatusAction	valueOfCode(String code)	Helper function to return the FinalStatusAction represented by code.
static FinalStatusAction[]	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

ContinueSubmitFrame

public static final FinalStatusAction ContinueSubmitFrame

If a submit frame is used, submit a new process according to that. Otherwise, do nothing

StopSubmitFrame

public static final FinalStatusAction StopSubmitFrame

If a submit frame is used, stop (preserve the final status code)

RequestRestart

public static final FinalStatusAction RequestRestart

Request final status action from the console

Restart

public static final FinalStatusAction Restart

Automatically restart the process, even if the processes RestartCount has reached zero

RestartNoResubmit

public static final FinalStatusAction RestartNoResubmit

Automatically restart the process, unless the processes RestartCount has reached zero

RestartFromError

public static final FinalStatusAction RestartFromError

Automatically restart the chain, starting at the step that ran into Error, Killed or Unknown

Field Detail

ContinueSubmitFrameCode

public static final char ContinueSubmitFrameCode

The char returned from ContinueSubmitFrame.getCodeEx().

See Also:

ContinueSubmitFrame, Constant Field Values

StopSubmitFrameCode

public static final char StopSubmitFrameCode

The char returned from StopSubmitFrame.getCodeEx().

See Also:

StopSubmitFrame, Constant Field Values

RequestRestartCode

public static final char RequestRestartCode

The char returned from RequestRestart.getCodeEx().

See Also:

RequestRestart, Constant Field Values

RestartCode

public static final char RestartCode

The char returned from Restart.getCodeEx().

See Also:

Restart, Constant Field Values

RestartNoResubmitCode

public static final char RestartNoResubmitCode

The char returned from RestartNoResubmit.getCodeEx().

See Also:

RestartNoResubmit, Constant Field Values

RestartFromErrorCode

public static final char RestartFromErrorCode

The char returned from RestartFromError.getCodeEx().

See Also:

RestartFromError, Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static FinalStatusAction 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 FinalStatusAction valueOfCode(String code)

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

Returns:

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

safeValueOf

public static FinalStatusAction safeValueOf(String value)

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

See Also:

valueOf(String)

valueOf

public static FinalStatusAction valueOf(Character code)

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

Parameters:

code - Character that is one of the codes for HandlerAction

Returns:

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

valueOf

public static FinalStatusAction valueOf(char code)

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

Parameters:

code - char that is one of the codes for HandlerAction

Returns:

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

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

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

Returns:

the database code for the enumeration