Enum SapBIProcessJobStatus
- java.lang.Object
-
- java.lang.Enum<SapBIProcessJobStatus>
-
- com.redwood.scheduler.api.model.enumeration.SapBIProcessJobStatus
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<SapBIProcessJobStatus,Character>
,SchedulerEnumeration<SapBIProcessJobStatus>
,Serializable
,Comparable<SapBIProcessJobStatus>
public enum SapBIProcessJobStatus extends Enum<SapBIProcessJobStatus> implements SchedulerEnumeration<SapBIProcessJobStatus>
What status a SAP BI process can have (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Canceled
The job has been killed.Completed
The job finished successfully.Error
The job finished with error.FrameworkError
The job ended in error because of an error in the BI framework.Planned
The job is created with no start condition.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.Running
The job is currently running.Skipped
The job has been skipped.SuccessfullyCompleted
The job finished successfully.Unknown
The job has been no status yet in the BI system.
-
Field Summary
Fields Modifier and Type Field Description static char
CanceledCode
The char returned from Canceled.getCodeEx().static char
CompletedCode
The char returned from Completed.getCodeEx().static char
ErrorCode
The char returned from Error.getCodeEx().static char
FrameworkErrorCode
The char returned from FrameworkError.getCodeEx().static char
PlannedCode
The char returned from Planned.getCodeEx().static char
ReadyCode
The char returned from Ready.getCodeEx().static char
ReleasedCode
The char returned from Released.getCodeEx().static char
RunningCode
The char returned from Running.getCodeEx().static char
SkippedCode
The char returned from Skipped.getCodeEx().static char
SuccessfullyCompletedCode
The char returned from SuccessfullyCompleted.getCodeEx().static char
UnknownCode
The char returned from Unknown.getCodeEx().
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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 SapBIProcessJobStatus
safeValueOf(String value)
Helper function to return the SapBIProcessJobStatus represented byvalue
.static SapBIProcessJobStatus
valueOf(char code)
Helper function to return the SapBIProcessJobStatus represented by code.static SapBIProcessJobStatus
valueOf(Character code)
Helper function to return the SapBIProcessJobStatus represented by code.static SapBIProcessJobStatus
valueOf(String name)
Returns the enum constant of this type with the specified name.static SapBIProcessJobStatus
valueOfCode(String code)
Helper function to return the SapBIProcessJobStatus represented by code.static SapBIProcessJobStatus[]
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 interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration
name, ordinal
-
Methods inherited from interface java.lang.Comparable
compareTo
-
-
-
-
Enum Constant Detail
-
Error
public static final SapBIProcessJobStatus Error
The job finished with error.
-
SuccessfullyCompleted
public static final SapBIProcessJobStatus SuccessfullyCompleted
The job finished successfully.
-
Completed
public static final SapBIProcessJobStatus Completed
The job finished successfully.
-
Running
public static final SapBIProcessJobStatus Running
The job is currently running.
-
Canceled
public static final SapBIProcessJobStatus Canceled
The job has been killed.
-
Planned
public static final SapBIProcessJobStatus Planned
The job is created with no start condition.
-
Skipped
public static final SapBIProcessJobStatus Skipped
The job has been skipped.
-
Released
public static final SapBIProcessJobStatus Released
The job has been scheduled and is now waiting for execution according to its start conditions.
-
Ready
public static final SapBIProcessJobStatus Ready
The job has been picked up by a batch work process but not started yet.
-
FrameworkError
public static final SapBIProcessJobStatus FrameworkError
The job ended in error because of an error in the BI framework.
-
Unknown
public static final SapBIProcessJobStatus Unknown
The job has been no status yet in the BI system.
-
-
Field Detail
-
ErrorCode
public static final char ErrorCode
The char returned from Error.getCodeEx().- See Also:
Error
, Constant Field Values
-
SuccessfullyCompletedCode
public static final char SuccessfullyCompletedCode
The char returned from SuccessfullyCompleted.getCodeEx().- See Also:
SuccessfullyCompleted
, Constant Field Values
-
CompletedCode
public static final char CompletedCode
The char returned from Completed.getCodeEx().- See Also:
Completed
, Constant Field Values
-
RunningCode
public static final char RunningCode
The char returned from Running.getCodeEx().- See Also:
Running
, Constant Field Values
-
CanceledCode
public static final char CanceledCode
The char returned from Canceled.getCodeEx().- See Also:
Canceled
, Constant Field Values
-
PlannedCode
public static final char PlannedCode
The char returned from Planned.getCodeEx().- See Also:
Planned
, Constant Field Values
-
SkippedCode
public static final char SkippedCode
The char returned from Skipped.getCodeEx().- See Also:
Skipped
, Constant Field Values
-
ReleasedCode
public static final char ReleasedCode
The char returned from Released.getCodeEx().- See Also:
Released
, Constant Field Values
-
ReadyCode
public static final char ReadyCode
The char returned from Ready.getCodeEx().- See Also:
Ready
, Constant Field Values
-
FrameworkErrorCode
public static final char FrameworkErrorCode
The char returned from FrameworkError.getCodeEx().- See Also:
FrameworkError
, 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 SapBIProcessJobStatus[] 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 (SapBIProcessJobStatus c : SapBIProcessJobStatus.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SapBIProcessJobStatus 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 nameNullPointerException
- if the argument is null
-
getMappedJobStatus
public JobStatus getMappedJobStatus()
-
valueOfCode
public static SapBIProcessJobStatus valueOfCode(String code)
Helper function to return the SapBIProcessJobStatus 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 SapBIProcessJobStatus- Returns:
- The SapBIProcessJobStatus corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static SapBIProcessJobStatus safeValueOf(String value)
Helper function to return the SapBIProcessJobStatus represented byvalue
. Ifvalue
is null, or not a valid SapBIProcessJobStatus 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 invalidvalue
,valueOf(String)
will throw anIllegalArgumentException
.- Parameters:
value
- The string value that corresponds to the requested enumeration value- Returns:
- The SapBIProcessJobStatus corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static SapBIProcessJobStatus valueOf(Character code)
Helper function to return the SapBIProcessJobStatus represented by code. If code is null, or not a valid SapBIProcessJobStatus code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The SapBIProcessJobStatus corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static SapBIProcessJobStatus valueOf(char code)
Helper function to return the SapBIProcessJobStatus represented by code. If code is not a valid SapBIProcessJobStatus code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The SapBIProcessJobStatus 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 interfaceSchedulerEnumeration<SapBIProcessJobStatus>
- 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 interfaceBaseSchedulerEnumeration<SapBIProcessJobStatus,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 interfaceSchedulerEnumeration<SapBIProcessJobStatus>
- 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 interfaceBaseSchedulerEnumeration<SapBIProcessJobStatus,Character>
- Returns:
- the key.
-
getTranslationEN
public String getTranslationEN()
Description copied from interface:BaseSchedulerEnumeration
Get the English name of this enumeration.- Specified by:
getTranslationEN
in interfaceBaseSchedulerEnumeration<SapBIProcessJobStatus,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 interfaceBaseSchedulerEnumeration<SapBIProcessJobStatus,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 interfaceSchedulerEnumeration<SapBIProcessJobStatus>
- Returns:
- the database code for the enumeration
-
-