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

Enum ForecastJobStatus

java.lang.Object

java.lang.Enum<ForecastJobStatus>

com.redwood.scheduler.api.model.enumeration.ForecastJobStatus

All Implemented Interfaces:

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

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

Forecast status of a forecast job. (Character Enumeration)

Enum Constant Summary

Enum Constants

Enum Constant	Description
Calculating	Placeholder process; the recurrence is calculating the forecast processes.
Deleted	The real process has been deleted.
Error	Some error occurred when this process was forecast.
Existing	The forecast process matches a real process in the system.
Forecast	Forecast process
FrequencyForecast	The forecast process represents a number of processes for a frequently running submit frame.

Field Summary

Fields

Modifier and Type	Field	Description
static char	CalculatingCode	The char returned from Calculating.getCodeEx().
static char	DeletedCode	The char returned from Deleted.getCodeEx().
static char	ErrorCode	The char returned from Error.getCodeEx().
static char	ExistingCode	The char returned from Existing.getCodeEx().
static char	ForecastCode	The char returned from Forecast.getCodeEx().
static char	FrequencyForecastCode	The char returned from FrequencyForecast.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 ForecastJobStatus	safeValueOf(String value)	Helper function to return the ForecastJobStatus represented by value.
static ForecastJobStatus	valueOf(char code)	Helper function to return the ForecastJobStatus represented by code.
static ForecastJobStatus	valueOf(Character code)	Helper function to return the ForecastJobStatus represented by code.
static ForecastJobStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ForecastJobStatus	valueOfCode(String code)	Helper function to return the ForecastJobStatus represented by code.
static ForecastJobStatus[]	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

Calculating

public static final ForecastJobStatus Calculating

Placeholder process; the recurrence is calculating the forecast processes.

Error

public static final ForecastJobStatus Error

Some error occurred when this process was forecast.

Existing

public static final ForecastJobStatus Existing

The forecast process matches a real process in the system.

Forecast

public static final ForecastJobStatus Forecast

Forecast process

FrequencyForecast

public static final ForecastJobStatus FrequencyForecast

The forecast process represents a number of processes for a frequently running submit frame.

Deleted

public static final ForecastJobStatus Deleted

The real process has been deleted.

Field Detail

CalculatingCode

public static final char CalculatingCode

The char returned from Calculating.getCodeEx().

See Also:

Calculating, Constant Field Values

ErrorCode

public static final char ErrorCode

The char returned from Error.getCodeEx().

See Also:

Error, Constant Field Values

ExistingCode

public static final char ExistingCode

The char returned from Existing.getCodeEx().

See Also:

Existing, Constant Field Values

ForecastCode

public static final char ForecastCode

The char returned from Forecast.getCodeEx().

See Also:

Forecast, Constant Field Values

FrequencyForecastCode

public static final char FrequencyForecastCode

The char returned from FrequencyForecast.getCodeEx().

See Also:

FrequencyForecast, Constant Field Values

DeletedCode

public static final char DeletedCode

The char returned from Deleted.getCodeEx().

See Also:

Deleted, Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

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

safeValueOf

public static ForecastJobStatus safeValueOf(String value)

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

See Also:

valueOf(String)

valueOf

public static ForecastJobStatus valueOf(Character code)

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

Parameters:

code - Character that is one of the codes for HandlerAction

Returns:

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

valueOf

public static ForecastJobStatus valueOf(char code)

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

Parameters:

code - char that is one of the codes for HandlerAction

Returns:

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

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

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

Returns:

the database code for the enumeration