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

Enum ProcessMonitorItemStatus

java.lang.Object

java.lang.Enum<ProcessMonitorItemStatus>

com.redwood.scheduler.api.model.enumeration.ProcessMonitorItemStatus

All Implemented Interfaces:

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

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

The status of the ProcessMonitorItem. (Character Enumeration)

Enum Constant Summary

Enum Constants

Enum Constant	Description
Completed	Item has been completed
Error	Process has run in error
InProgress	Item is in progress
ManualTask	Item require manual attention
NotStarted	Item has not been started
Warning	One of the child processes has run in error

Field Summary

Fields

Modifier and Type	Field	Description
static char	CompletedCode	The char returned from Completed.getCodeEx().
static char	ErrorCode	The char returned from Error.getCodeEx().
static char	InProgressCode	The char returned from InProgress.getCodeEx().
static char	ManualTaskCode	The char returned from ManualTask.getCodeEx().
static char	NotStartedCode	The char returned from NotStarted.getCodeEx().
static char	WarningCode	The char returned from Warning.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 ProcessMonitorItemStatus	safeValueOf(String value)	Helper function to return the ProcessMonitorItemStatus represented by value.
static ProcessMonitorItemStatus	valueOf(char code)	Helper function to return the ProcessMonitorItemStatus represented by code.
static ProcessMonitorItemStatus	valueOf(Character code)	Helper function to return the ProcessMonitorItemStatus represented by code.
static ProcessMonitorItemStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ProcessMonitorItemStatus	valueOfCode(String code)	Helper function to return the ProcessMonitorItemStatus represented by code.
static ProcessMonitorItemStatus[]	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

NotStarted

public static final ProcessMonitorItemStatus NotStarted

Item has not been started

InProgress

public static final ProcessMonitorItemStatus InProgress

Item is in progress

ManualTask

public static final ProcessMonitorItemStatus ManualTask

Item require manual attention

Completed

public static final ProcessMonitorItemStatus Completed

Item has been completed

Error

public static final ProcessMonitorItemStatus Error

Process has run in error

Warning

public static final ProcessMonitorItemStatus Warning

One of the child processes has run in error

Field Detail

NotStartedCode

public static final char NotStartedCode

The char returned from NotStarted.getCodeEx().

See Also:

NotStarted, Constant Field Values

InProgressCode

public static final char InProgressCode

The char returned from InProgress.getCodeEx().

See Also:

InProgress, Constant Field Values

ManualTaskCode

public static final char ManualTaskCode

The char returned from ManualTask.getCodeEx().

See Also:

ManualTask, Constant Field Values

CompletedCode

public static final char CompletedCode

The char returned from Completed.getCodeEx().

See Also:

Completed, Constant Field Values

ErrorCode

public static final char ErrorCode

The char returned from Error.getCodeEx().

See Also:

Error, Constant Field Values

WarningCode

public static final char WarningCode

The char returned from Warning.getCodeEx().

See Also:

Warning, Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

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

safeValueOf

public static ProcessMonitorItemStatus safeValueOf(String value)

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

See Also:

valueOf(String)

valueOf

public static ProcessMonitorItemStatus valueOf(Character code)

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

Parameters:

code - Character that is one of the codes for HandlerAction

Returns:

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

valueOf

public static ProcessMonitorItemStatus valueOf(char code)

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

Parameters:

code - char that is one of the codes for HandlerAction

Returns:

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

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

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

Returns:

the database code for the enumeration