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

All Implemented Interfaces:

BaseSchedulerEnumeration<JobStatusState,Character>, SchedulerEnumeration<JobStatusState>, Serializable, Comparable<JobStatusState>
```
public enum JobStatusState
extends Enum<JobStatusState>
implements SchedulerEnumeration<JobStatusState>
```
What type of State a Status represents (Character Enumeration)

Enum Constant Summary

Enum Constants
Enum Constant	Description
`Executing`	The status represents something that has been started, but has not completed
`Final`	The status represents something that has completed
`Idle`	The status represents something that has been started, but is currently waiting on another process to finish
`Initial`	The status represents an initial state for the process
`New`	The status represents a new process
`Other`	The status represents something that does not fit into the other categories
`Pending`	The status represents something that is pending execution
`PreExecuting`	The status represents something that is in the process of starting

Field Summary

Fields
Modifier and Type	Field	Description
`static char`	`ExecutingCode`	The char returned from Executing.getCodeEx().
`static char`	`FinalCode`	The char returned from Final.getCodeEx().
`static char`	`IdleCode`	The char returned from Idle.getCodeEx().
`static char`	`InitialCode`	The char returned from Initial.getCodeEx().
`static char`	`NewCode`	The char returned from New.getCodeEx().
`static char`	`OtherCode`	The char returned from Other.getCodeEx().
`static char`	`PendingCode`	The char returned from Pending.getCodeEx().
`static char`	`PreExecutingCode`	The char returned from PreExecuting.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.
`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 JobStatusState`	`safeValueOf(String value)`	Helper function to return the JobStatusState represented by `value`.
`static JobStatusState`	`valueOf(char code)`	Helper function to return the JobStatusState represented by code.
`static JobStatusState`	`valueOf(Character code)`	Helper function to return the JobStatusState represented by code.
`static JobStatusState`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static JobStatusState`	`valueOfCode(String code)`	Helper function to return the JobStatusState represented by code.
`static JobStatusState[]`	`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
  - Initial
```
public static final JobStatusState Initial
```
    The status represents an initial state for the process
  - Pending
```
public static final JobStatusState Pending
```
    The status represents something that is pending execution
  - PreExecuting
```
public static final JobStatusState PreExecuting
```
    The status represents something that is in the process of starting
  - Executing
```
public static final JobStatusState Executing
```
    The status represents something that has been started, but has not completed
  - Idle
```
public static final JobStatusState Idle
```
    The status represents something that has been started, but is currently waiting on another process to finish
  - Final
```
public static final JobStatusState Final
```
    The status represents something that has completed
  - New
```
public static final JobStatusState New
```
    The status represents a new process
  - Other
```
public static final JobStatusState Other
```
    The status represents something that does not fit into the other categories
- Field Detail
  - InitialCode
```
public static final char InitialCode
```
    The char returned from Initial.getCodeEx().
    
    See Also:
    
    Initial, Constant Field Values
  - PendingCode
```
public static final char PendingCode
```
    The char returned from Pending.getCodeEx().
    
    See Also:
    
    Pending, Constant Field Values
  - PreExecutingCode
```
public static final char PreExecutingCode
```
    The char returned from PreExecuting.getCodeEx().
    
    See Also:
    
    PreExecuting, Constant Field Values
  - ExecutingCode
```
public static final char ExecutingCode
```
    The char returned from Executing.getCodeEx().
    
    See Also:
    
    Executing, Constant Field Values
  - IdleCode
```
public static final char IdleCode
```
    The char returned from Idle.getCodeEx().
    
    See Also:
    
    Idle, Constant Field Values
  - FinalCode
```
public static final char FinalCode
```
    The char returned from Final.getCodeEx().
    
    See Also:
    
    Final, Constant Field Values
  - NewCode
```
public static final char NewCode
```
    The char returned from New.getCodeEx().
    
    See Also:
    
    New, Constant Field Values
  - OtherCode
```
public static final char OtherCode
```
    The char returned from Other.getCodeEx().
    
    See Also:
    
    Other, Constant Field Values
- Method Detail
  - values
```
public static JobStatusState[] 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 (JobStatusState c : JobStatusState.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static JobStatusState 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
  - valueOfCode
```
public static JobStatusState valueOfCode(String code)
```
    Helper function to return the JobStatusState 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 JobStatusState
    
    Returns:
    
    The JobStatusState corresponding to code, or null, if code is null, longer than one character, or not a valid code
  - safeValueOf
```
public static JobStatusState safeValueOf(String value)
```
    Helper function to return the JobStatusState represented by value. If value is null, or not a valid JobStatusState 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 JobStatusState corresponding to value, or null, if value is null, or not a valid enumeration
    
    See Also:
    
    valueOf(String)
  - valueOf
```
public static JobStatusState valueOf(Character code)
```
    Helper function to return the JobStatusState represented by code. If code is null, or not a valid JobStatusState code then this method will return null.
    
    Parameters:
    
    code - Character that is one of the codes for HandlerAction
    
    Returns:
    
    The JobStatusState corresponding to code, or null, if code is null, or not a valid code
  - valueOf
```
public static JobStatusState valueOf(char code)
```
    Helper function to return the JobStatusState represented by code. If code is not a valid JobStatusState code then this method will return null.
    
    Parameters:
    
    code - char that is one of the codes for HandlerAction
    
    Returns:
    
    The JobStatusState 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<JobStatusState>
    
    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<JobStatusState,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<JobStatusState>
    
    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<JobStatusState,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<JobStatusState,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<JobStatusState,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<JobStatusState>
    
    Returns:
    
    the database code for the enumeration

Enum JobStatusState

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

Initial

Pending

PreExecuting

Executing

Idle

Final

New

Other

Field Detail

InitialCode

PendingCode

PreExecutingCode

ExecutingCode

IdleCode

FinalCode

NewCode

OtherCode

Method Detail

values

valueOf

valueOfCode

safeValueOf

valueOf

valueOf

getCodeEx

getCodeExValue

getCodeExCharacter

getTranslationKey

getTranslationEN

getDescriptionKey

getCodeExString