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

All Implemented Interfaces:

BaseSchedulerEnumeration<OraOhiJobStatus,Character>, SchedulerEnumeration<OraOhiJobStatus>, Serializable, Comparable<OraOhiJobStatus>
```
public enum OraOhiJobStatus
extends Enum<OraOhiJobStatus>
implements SchedulerEnumeration<OraOhiJobStatus>
```
What status an OraOhi job can have (Character Enumeration)

Enum Constant Summary

Enum Constants
Enum Constant	Description
`Completed`	The OHI script successfully completed.
`CompletedB`	The OHI script successfully completed (time was up, the rest will be done later).
`Error`	The OHI script encountered an error.
`ErrorE`	The OHI script encountered an exclusive userlock, for this process, yet it was free.
`ErrorM`	The OHI script encountered an error, most likely caused due to an external call.
`Running`	The OHI script is executing (running).
`Start`	The scheduler of OHI puts the script into Start just before it goes to running.
`Waiting`	A script in OHI is in waiting status to be picked up by OHI scheduler.
`WaitingV`	A request to submit a script in OHI has been initiated, this is the initial status it gets.

Field Summary

Fields
Modifier and Type	Field	Description
`static char`	`CompletedBCode`	The char returned from CompletedB.getCodeEx().
`static char`	`CompletedCode`	The char returned from Completed.getCodeEx().
`static char`	`ErrorCode`	The char returned from Error.getCodeEx().
`static char`	`ErrorECode`	The char returned from ErrorE.getCodeEx().
`static char`	`ErrorMCode`	The char returned from ErrorM.getCodeEx().
`static char`	`RunningCode`	The char returned from Running.getCodeEx().
`static char`	`StartCode`	The char returned from Start.getCodeEx().
`static char`	`WaitingCode`	The char returned from Waiting.getCodeEx().
`static char`	`WaitingVCode`	The char returned from WaitingV.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 OraOhiJobStatus`	`safeValueOf(String value)`	Helper function to return the OraOhiJobStatus represented by `value`.
`static OraOhiJobStatus`	`valueOf(char code)`	Helper function to return the OraOhiJobStatus represented by code.
`static OraOhiJobStatus`	`valueOf(Character code)`	Helper function to return the OraOhiJobStatus represented by code.
`static OraOhiJobStatus`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static OraOhiJobStatus`	`valueOfCode(String code)`	Helper function to return the OraOhiJobStatus represented by code.
`static OraOhiJobStatus[]`	`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
  - WaitingV
```
public static final OraOhiJobStatus WaitingV
```
    A request to submit a script in OHI has been initiated, this is the initial status it gets.
  - Waiting
```
public static final OraOhiJobStatus Waiting
```
    A script in OHI is in waiting status to be picked up by OHI scheduler.
  - Start
```
public static final OraOhiJobStatus Start
```
    The scheduler of OHI puts the script into Start just before it goes to running.
  - Running
```
public static final OraOhiJobStatus Running
```
    The OHI script is executing (running).
  - Completed
```
public static final OraOhiJobStatus Completed
```
    The OHI script successfully completed.
  - CompletedB
```
public static final OraOhiJobStatus CompletedB
```
    The OHI script successfully completed (time was up, the rest will be done later).
  - Error
```
public static final OraOhiJobStatus Error
```
    The OHI script encountered an error.
  - ErrorE
```
public static final OraOhiJobStatus ErrorE
```
    The OHI script encountered an exclusive userlock, for this process, yet it was free.
  - ErrorM
```
public static final OraOhiJobStatus ErrorM
```
    The OHI script encountered an error, most likely caused due to an external call.
- Field Detail
  - WaitingVCode
```
public static final char WaitingVCode
```
    The char returned from WaitingV.getCodeEx().
    
    See Also:
    
    WaitingV, Constant Field Values
  - WaitingCode
```
public static final char WaitingCode
```
    The char returned from Waiting.getCodeEx().
    
    See Also:
    
    Waiting, Constant Field Values
  - StartCode
```
public static final char StartCode
```
    The char returned from Start.getCodeEx().
    
    See Also:
    
    Start, Constant Field Values
  - RunningCode
```
public static final char RunningCode
```
    The char returned from Running.getCodeEx().
    
    See Also:
    
    Running, Constant Field Values
  - CompletedCode
```
public static final char CompletedCode
```
    The char returned from Completed.getCodeEx().
    
    See Also:
    
    Completed, Constant Field Values
  - CompletedBCode
```
public static final char CompletedBCode
```
    The char returned from CompletedB.getCodeEx().
    
    See Also:
    
    CompletedB, Constant Field Values
  - ErrorCode
```
public static final char ErrorCode
```
    The char returned from Error.getCodeEx().
    
    See Also:
    
    Error, Constant Field Values
  - ErrorECode
```
public static final char ErrorECode
```
    The char returned from ErrorE.getCodeEx().
    
    See Also:
    
    ErrorE, Constant Field Values
  - ErrorMCode
```
public static final char ErrorMCode
```
    The char returned from ErrorM.getCodeEx().
    
    See Also:
    
    ErrorM, Constant Field Values
- Method Detail
  - values
```
public static OraOhiJobStatus[] 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 (OraOhiJobStatus c : OraOhiJobStatus.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static OraOhiJobStatus 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 OraOhiJobStatus valueOfCode(String code)
```
    Helper function to return the OraOhiJobStatus 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 OraOhiJobStatus
    
    Returns:
    
    The OraOhiJobStatus corresponding to code, or null, if code is null, longer than one character, or not a valid code
  - safeValueOf
```
public static OraOhiJobStatus safeValueOf(String value)
```
    Helper function to return the OraOhiJobStatus represented by value. If value is null, or not a valid OraOhiJobStatus 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 OraOhiJobStatus corresponding to value, or null, if value is null, or not a valid enumeration
    
    See Also:
    
    valueOf(String)
  - valueOf
```
public static OraOhiJobStatus valueOf(Character code)
```
    Helper function to return the OraOhiJobStatus represented by code. If code is null, or not a valid OraOhiJobStatus code then this method will return null.
    
    Parameters:
    
    code - Character that is one of the codes for HandlerAction
    
    Returns:
    
    The OraOhiJobStatus corresponding to code, or null, if code is null, or not a valid code
  - valueOf
```
public static OraOhiJobStatus valueOf(char code)
```
    Helper function to return the OraOhiJobStatus represented by code. If code is not a valid OraOhiJobStatus code then this method will return null.
    
    Parameters:
    
    code - char that is one of the codes for HandlerAction
    
    Returns:
    
    The OraOhiJobStatus 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<OraOhiJobStatus>
    
    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<OraOhiJobStatus,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<OraOhiJobStatus>
    
    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<OraOhiJobStatus,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<OraOhiJobStatus,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<OraOhiJobStatus,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<OraOhiJobStatus>
    
    Returns:
    
    the database code for the enumeration

Enum OraOhiJobStatus

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

WaitingV

Waiting

Start

Running

Completed

CompletedB

Error

ErrorE

ErrorM

Field Detail

WaitingVCode

WaitingCode

StartCode

RunningCode

CompletedCode

CompletedBCode

ErrorCode

ErrorECode

ErrorMCode

Method Detail

values

valueOf

getMappedJobStatus

valueOfCode

safeValueOf

valueOf

valueOf

getCodeEx

getCodeExValue

getCodeExCharacter

getTranslationKey

getTranslationEN

getDescriptionKey

getCodeExString