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

Enum SapBIInfoPackageJobStatus

java.lang.Object

java.lang.Enum<SapBIInfoPackageJobStatus>

com.redwood.scheduler.api.model.enumeration.SapBIInfoPackageJobStatus

All Implemented Interfaces:

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

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

What status a SAP BI InfoPackage can have (Character Enumeration)

Enum Constant Summary

Enum Constants

Enum Constant	Description
Error	The job finished with error.
Finished	The job finished successfully.
Running	The job is currently running.
Unknown	The status of the job is not known yet.

Field Summary

Fields

Modifier and Type	Field	Description
static char	ErrorCode	The char returned from Error.getCodeEx().
static char	FinishedCode	The char returned from Finished.getCodeEx().
static char	RunningCode	The char returned from Running.getCodeEx().
static char	UnknownCode	The char returned from Unknown.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.
static SapBIInfoPackageJobStatus	safeValueOf(String value)	Helper function to return the SapBIInfoPackageJobStatus represented by value.
static SapBIInfoPackageJobStatus	valueOf(char code)	Helper function to return the SapBIInfoPackageJobStatus represented by code.
static SapBIInfoPackageJobStatus	valueOf(Character code)	Helper function to return the SapBIInfoPackageJobStatus represented by code.
static SapBIInfoPackageJobStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SapBIInfoPackageJobStatus	valueOfCode(String code)	Helper function to return the SapBIInfoPackageJobStatus represented by code.
static SapBIInfoPackageJobStatus[]	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

Finished

public static final SapBIInfoPackageJobStatus Finished

The job finished successfully.

Error

public static final SapBIInfoPackageJobStatus Error

The job finished with error.

Running

public static final SapBIInfoPackageJobStatus Running

The job is currently running.

Unknown

public static final SapBIInfoPackageJobStatus Unknown

The status of the job is not known yet.

Field Detail

FinishedCode

public static final char FinishedCode

The char returned from Finished.getCodeEx().

See Also:

Finished, Constant Field Values

ErrorCode

public static final char ErrorCode

The char returned from Error.getCodeEx().

See Also:

Error, Constant Field Values

RunningCode

public static final char RunningCode

The char returned from Running.getCodeEx().

See Also:

Running, Constant Field Values

UnknownCode

public static final char UnknownCode

The char returned from Unknown.getCodeEx().

See Also:

Unknown, Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static SapBIInfoPackageJobStatus 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()

valueOfCode

public static SapBIInfoPackageJobStatus valueOfCode(String code)

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

Returns:

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

safeValueOf

public static SapBIInfoPackageJobStatus safeValueOf(String value)

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

See Also:

valueOf(String)

valueOf

public static SapBIInfoPackageJobStatus valueOf(Character code)

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

Parameters:

code - Character that is one of the codes for HandlerAction

Returns:

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

valueOf

public static SapBIInfoPackageJobStatus valueOf(char code)

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

Parameters:

code - char that is one of the codes for HandlerAction

Returns:

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

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

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

Returns:

the database code for the enumeration