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

Enum SapBatchJobStatus

java.lang.Object

java.lang.Enum<SapBatchJobStatus>

com.redwood.scheduler.api.model.enumeration.SapBatchJobStatus

All Implemented Interfaces:

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

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

What status a SAP batch job can have (Character Enumeration)

Enum Constant Summary

Enum Constants

Enum Constant	Description
Canceled	The job finished with error, or has been killed.
Finished	The job finished successfully.
Intercepted	The job has been intercepted.
Ready	The job has been picked up by a batch work process but not started yet.
Released	The job has been scheduled and is now waiting for execution according to its start conditions.
ReleaseSuspended	The job has been suspended because an upgrade of the SAP batch system is currently running.
Running	The job is currently running.
Scheduled	The job is created with no start condition.

Field Summary

Fields

Modifier and Type	Field	Description
static char	CanceledCode	The char returned from Canceled.getCodeEx().
static char	FinishedCode	The char returned from Finished.getCodeEx().
static char	InterceptedCode	The char returned from Intercepted.getCodeEx().
static char	ReadyCode	The char returned from Ready.getCodeEx().
static char	ReleasedCode	The char returned from Released.getCodeEx().
static char	ReleaseSuspendedCode	The char returned from ReleaseSuspended.getCodeEx().
static char	RunningCode	The char returned from Running.getCodeEx().
static char	ScheduledCode	The char returned from Scheduled.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.
JobStatus	getMappedJobStatus()
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	isSuspended()
static SapBatchJobStatus	safeValueOf(String value)	Helper function to return the SapBatchJobStatus represented by value.
static SapBatchJobStatus	valueOf(char code)	Helper function to return the SapBatchJobStatus represented by code.
static SapBatchJobStatus	valueOf(Character code)	Helper function to return the SapBatchJobStatus represented by code.
static SapBatchJobStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SapBatchJobStatus	valueOfCode(String code)	Helper function to return the SapBatchJobStatus represented by code.
static SapBatchJobStatus[]	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

Canceled

public static final SapBatchJobStatus Canceled

The job finished with error, or has been killed.

Finished

public static final SapBatchJobStatus Finished

The job finished successfully.

Running

public static final SapBatchJobStatus Running

The job is currently running.

Scheduled

public static final SapBatchJobStatus Scheduled

The job is created with no start condition.

Ready

public static final SapBatchJobStatus Ready

The job has been picked up by a batch work process but not started yet.

Released

public static final SapBatchJobStatus Released

The job has been scheduled and is now waiting for execution according to its start conditions.

Intercepted

public static final SapBatchJobStatus Intercepted

The job has been intercepted.

ReleaseSuspended

public static final SapBatchJobStatus ReleaseSuspended

The job has been suspended because an upgrade of the SAP batch system is currently running.

Field Detail

CanceledCode

public static final char CanceledCode

The char returned from Canceled.getCodeEx().

See Also:

Canceled, Constant Field Values

FinishedCode

public static final char FinishedCode

The char returned from Finished.getCodeEx().

See Also:

Finished, Constant Field Values

RunningCode

public static final char RunningCode

The char returned from Running.getCodeEx().

See Also:

Running, Constant Field Values

ScheduledCode

public static final char ScheduledCode

The char returned from Scheduled.getCodeEx().

See Also:

Scheduled, Constant Field Values

ReadyCode

public static final char ReadyCode

The char returned from Ready.getCodeEx().

See Also:

Ready, Constant Field Values

ReleasedCode

public static final char ReleasedCode

The char returned from Released.getCodeEx().

See Also:

Released, Constant Field Values

InterceptedCode

public static final char InterceptedCode

The char returned from Intercepted.getCodeEx().

See Also:

Intercepted, Constant Field Values

ReleaseSuspendedCode

public static final char ReleaseSuspendedCode

The char returned from ReleaseSuspended.getCodeEx().

See Also:

ReleaseSuspended, Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getMappedJobStatus

public JobStatus getMappedJobStatus()

isSuspended

public boolean isSuspended()

valueOfCode

public static SapBatchJobStatus valueOfCode(String code)

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

Returns:

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

safeValueOf

public static SapBatchJobStatus safeValueOf(String value)

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

See Also:

valueOf(String)

valueOf

public static SapBatchJobStatus valueOf(Character code)

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

Parameters:

code - Character that is one of the codes for HandlerAction

Returns:

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

valueOf

public static SapBatchJobStatus valueOf(char code)

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

Parameters:

code - char that is one of the codes for HandlerAction

Returns:

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

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

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

Returns:

the database code for the enumeration