java.lang.Object
- java.lang.Enum<OraAppsBatchJobStatus>
- - com.redwood.scheduler.api.model.enumeration.OraAppsBatchJobStatus

All Implemented Interfaces:

BaseSchedulerEnumeration<OraAppsBatchJobStatus,Character>, SchedulerEnumeration<OraAppsBatchJobStatus>, Serializable, Comparable<OraAppsBatchJobStatus>
```
public enum OraAppsBatchJobStatus
extends Enum<OraAppsBatchJobStatus>
implements SchedulerEnumeration<OraAppsBatchJobStatus>
```
What status a OraApps batch job can have (Character Enumeration)

Enum Constant Summary

Enum Constants
Enum Constant	Description
`Cancelled`	Pending or Inactive request is canceled by choosing the Cancel Request button in the Requests window.
`Completed`	Request completed successfully.
`Disabled`	Program to run request is not enabled.
`Error`	Request failed to complete successfully.
`NoManager`	No manager is defined to run the request.
`Normal`	Request is running normally.
`OnHold`	Pending request is placed on hold by choosing the Hold Request button in the Requests window.
`Paused`	Parent request pauses for all its child requests to finish running.
`PendingNormal`	Request is waiting for the next available manager.
`Resuming`	All requests submitted by the same parent request have completed running.
`Scheduled`	Request is scheduled to start at a future time or date.
`StandBy`	Program to run request is incompatible with other program(s) currently running.
`Suspended`	Request is inactive and suspended.
`Terminated`	Request is terminated by choosing the Cancel Request button in the Requests window.
`Terminating`	Request is terminated by choosing the Cancel Request button in Requests window.
`Waiting`	A child request is waiting for its Parent request to mark it ready to run.
`WaitingZ`	A child request is waiting for its Parent request to mark it ready to run.
`Warning`	Request completed with warnings.

Field Summary

Fields
Modifier and Type	Field	Description
`static char`	`CancelledCode`	The char returned from Cancelled.getCodeEx().
`static char`	`CompletedCode`	The char returned from Completed.getCodeEx().
`static char`	`DisabledCode`	The char returned from Disabled.getCodeEx().
`static char`	`ErrorCode`	The char returned from Error.getCodeEx().
`static char`	`NoManagerCode`	The char returned from NoManager.getCodeEx().
`static char`	`NormalCode`	The char returned from Normal.getCodeEx().
`static char`	`OnHoldCode`	The char returned from OnHold.getCodeEx().
`static char`	`PausedCode`	The char returned from Paused.getCodeEx().
`static char`	`PendingNormalCode`	The char returned from PendingNormal.getCodeEx().
`static char`	`ResumingCode`	The char returned from Resuming.getCodeEx().
`static char`	`ScheduledCode`	The char returned from Scheduled.getCodeEx().
`static char`	`StandByCode`	The char returned from StandBy.getCodeEx().
`static char`	`SuspendedCode`	The char returned from Suspended.getCodeEx().
`static char`	`TerminatedCode`	The char returned from Terminated.getCodeEx().
`static char`	`TerminatingCode`	The char returned from Terminating.getCodeEx().
`static char`	`WaitingCode`	The char returned from Waiting.getCodeEx().
`static char`	`WaitingZCode`	The char returned from WaitingZ.getCodeEx().
`static char`	`WarningCode`	The char returned from Warning.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 OraAppsBatchJobStatus`	`safeValueOf(String value)`	Helper function to return the OraAppsBatchJobStatus represented by `value`.
`static OraAppsBatchJobStatus`	`valueOf(char code)`	Helper function to return the OraAppsBatchJobStatus represented by code.
`static OraAppsBatchJobStatus`	`valueOf(Character code)`	Helper function to return the OraAppsBatchJobStatus represented by code.
`static OraAppsBatchJobStatus`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static OraAppsBatchJobStatus`	`valueOfCode(String code)`	Helper function to return the OraAppsBatchJobStatus represented by code.
`static OraAppsBatchJobStatus[]`	`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
  - Waiting
```
public static final OraAppsBatchJobStatus Waiting
```
    A child request is waiting for its Parent request to mark it ready to run. For example, a request in a request set that runs sequentially must wait for a prior request to complete.
  - Resuming
```
public static final OraAppsBatchJobStatus Resuming
```
    All requests submitted by the same parent request have completed running. The Parent request resumes running.
  - Completed
```
public static final OraAppsBatchJobStatus Completed
```
    Request completed successfully.
  - Cancelled
```
public static final OraAppsBatchJobStatus Cancelled
```
    Pending or Inactive request is canceled by choosing the Cancel Request button in the Requests window.
  - Error
```
public static final OraAppsBatchJobStatus Error
```
    Request failed to complete successfully.
  - Warning
```
public static final OraAppsBatchJobStatus Warning
```
    Request completed with warnings. For example, a request is generated successfully but fails to print.
  - OnHold
```
public static final OraAppsBatchJobStatus OnHold
```
    Pending request is placed on hold by choosing the Hold Request button in the Requests window.
  - PendingNormal
```
public static final OraAppsBatchJobStatus PendingNormal
```
    Request is waiting for the next available manager.
  - NoManager
```
public static final OraAppsBatchJobStatus NoManager
```
    No manager is defined to run the request. Check with your system administrator. A status of No Manager is also given when all managers are locked by run-alone requests.
  - Scheduled
```
public static final OraAppsBatchJobStatus Scheduled
```
    Request is scheduled to start at a future time or date.
  - StandBy
```
public static final OraAppsBatchJobStatus StandBy
```
    Program to run request is incompatible with other program(s) currently running.
  - Normal
```
public static final OraAppsBatchJobStatus Normal
```
    Request is running normally.
  - Suspended
```
public static final OraAppsBatchJobStatus Suspended
```
    Request is inactive and suspended.
  - Terminating
```
public static final OraAppsBatchJobStatus Terminating
```
    Request is terminated by choosing the Cancel Request button in Requests window.
  - Disabled
```
public static final OraAppsBatchJobStatus Disabled
```
    Program to run request is not enabled. Contact your system administrator.
  - Paused
```
public static final OraAppsBatchJobStatus Paused
```
    Parent request pauses for all its child requests to finish running. For example, a request set pauses for all requests in the set to complete.
  - Terminated
```
public static final OraAppsBatchJobStatus Terminated
```
    Request is terminated by choosing the Cancel Request button in the Requests window.
  - WaitingZ
```
public static final OraAppsBatchJobStatus WaitingZ
```
    A child request is waiting for its Parent request to mark it ready to run. For example, a request in a request set that runs sequentially must wait for a prior request to complete.
- Field Detail
  - WaitingCode
```
public static final char WaitingCode
```
    The char returned from Waiting.getCodeEx().
    
    See Also:
    
    Waiting, Constant Field Values
  - ResumingCode
```
public static final char ResumingCode
```
    The char returned from Resuming.getCodeEx().
    
    See Also:
    
    Resuming, Constant Field Values
  - CompletedCode
```
public static final char CompletedCode
```
    The char returned from Completed.getCodeEx().
    
    See Also:
    
    Completed, Constant Field Values
  - CancelledCode
```
public static final char CancelledCode
```
    The char returned from Cancelled.getCodeEx().
    
    See Also:
    
    Cancelled, 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
  - OnHoldCode
```
public static final char OnHoldCode
```
    The char returned from OnHold.getCodeEx().
    
    See Also:
    
    OnHold, Constant Field Values
  - PendingNormalCode
```
public static final char PendingNormalCode
```
    The char returned from PendingNormal.getCodeEx().
    
    See Also:
    
    PendingNormal, Constant Field Values
  - NoManagerCode
```
public static final char NoManagerCode
```
    The char returned from NoManager.getCodeEx().
    
    See Also:
    
    NoManager, Constant Field Values
  - ScheduledCode
```
public static final char ScheduledCode
```
    The char returned from Scheduled.getCodeEx().
    
    See Also:
    
    Scheduled, Constant Field Values
  - StandByCode
```
public static final char StandByCode
```
    The char returned from StandBy.getCodeEx().
    
    See Also:
    
    StandBy, Constant Field Values
  - NormalCode
```
public static final char NormalCode
```
    The char returned from Normal.getCodeEx().
    
    See Also:
    
    Normal, Constant Field Values
  - SuspendedCode
```
public static final char SuspendedCode
```
    The char returned from Suspended.getCodeEx().
    
    See Also:
    
    Suspended, Constant Field Values
  - TerminatingCode
```
public static final char TerminatingCode
```
    The char returned from Terminating.getCodeEx().
    
    See Also:
    
    Terminating, Constant Field Values
  - DisabledCode
```
public static final char DisabledCode
```
    The char returned from Disabled.getCodeEx().
    
    See Also:
    
    Disabled, Constant Field Values
  - PausedCode
```
public static final char PausedCode
```
    The char returned from Paused.getCodeEx().
    
    See Also:
    
    Paused, Constant Field Values
  - TerminatedCode
```
public static final char TerminatedCode
```
    The char returned from Terminated.getCodeEx().
    
    See Also:
    
    Terminated, Constant Field Values
  - WaitingZCode
```
public static final char WaitingZCode
```
    The char returned from WaitingZ.getCodeEx().
    
    See Also:
    
    WaitingZ, Constant Field Values
- Method Detail
  - values
```
public static OraAppsBatchJobStatus[] 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 (OraAppsBatchJobStatus c : OraAppsBatchJobStatus.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static OraAppsBatchJobStatus 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 OraAppsBatchJobStatus valueOfCode(String code)
```
    Helper function to return the OraAppsBatchJobStatus 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 OraAppsBatchJobStatus
    
    Returns:
    
    The OraAppsBatchJobStatus corresponding to code, or null, if code is null, longer than one character, or not a valid code
  - safeValueOf
```
public static OraAppsBatchJobStatus safeValueOf(String value)
```
    Helper function to return the OraAppsBatchJobStatus represented by value. If value is null, or not a valid OraAppsBatchJobStatus 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 OraAppsBatchJobStatus corresponding to value, or null, if value is null, or not a valid enumeration
    
    See Also:
    
    valueOf(String)
  - valueOf
```
public static OraAppsBatchJobStatus valueOf(Character code)
```
    Helper function to return the OraAppsBatchJobStatus represented by code. If code is null, or not a valid OraAppsBatchJobStatus code then this method will return null.
    
    Parameters:
    
    code - Character that is one of the codes for HandlerAction
    
    Returns:
    
    The OraAppsBatchJobStatus corresponding to code, or null, if code is null, or not a valid code
  - valueOf
```
public static OraAppsBatchJobStatus valueOf(char code)
```
    Helper function to return the OraAppsBatchJobStatus represented by code. If code is not a valid OraAppsBatchJobStatus code then this method will return null.
    
    Parameters:
    
    code - char that is one of the codes for HandlerAction
    
    Returns:
    
    The OraAppsBatchJobStatus 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<OraAppsBatchJobStatus>
    
    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<OraAppsBatchJobStatus,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<OraAppsBatchJobStatus>
    
    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<OraAppsBatchJobStatus,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<OraAppsBatchJobStatus,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<OraAppsBatchJobStatus,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<OraAppsBatchJobStatus>
    
    Returns:
    
    the database code for the enumeration

Enum OraAppsBatchJobStatus

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration

Methods inherited from interface java.lang.Comparable

Enum Constant Detail

Waiting

Resuming

Completed

Cancelled

Error

Warning

OnHold

PendingNormal

NoManager

Scheduled

StandBy

Normal

Suspended

Terminating

Disabled

Paused

Terminated

WaitingZ

Field Detail

WaitingCode

ResumingCode

CompletedCode

CancelledCode

ErrorCode

WarningCode

OnHoldCode

PendingNormalCode

NoManagerCode

ScheduledCode

StandByCode

NormalCode

SuspendedCode

TerminatingCode

DisabledCode

PausedCode

TerminatedCode

WaitingZCode

Method Detail

values

valueOf

getMappedJobStatus

valueOfCode

safeValueOf

valueOf

valueOf

getCodeEx

getCodeExValue

getCodeExCharacter

getTranslationKey

getTranslationEN

getDescriptionKey

getCodeExString