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

All Implemented Interfaces:

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

Enum Constant Summary

Enum Constants
Enum Constant	Description
`Assigned`	The process has been accepted by the Service and a process has been created in the remote system, but it has not been started yet.
`Canceled`	The process was terminated before execution commenced.
`Canceling`	A request was made to cancel the process and the ProcessService has honored that request.
`Chained`	A chain is requested and all processes in the chain have been created and are awaiting execution
`Completed`	Process execution finished successfully.
`Console`	The process has issued an OperatorMessage to the Messages monitor and is waiting for a reply.
`ConsoleRestart`	An operator message needs to be replied to in order to decide what to do with this process
`Delayed`	The child process is waiting for the parent process to finish
`Disabled`	The process server will not execute the process in a chain due to a manual request of the user.
`Dispatched`	The process has been dispatched to a Service, but the Service has not yet started the process.
`Error`	The execution of the process failed.
`EventWait`	The process is waiting for an Event to be raised.
`Held`	The execution of the process has been manually paused.
`Ignored`	This process was ignored as a result of being Disabled when the chain was called.
`Killed`	The process was terminated while it was running (process status was RUNNING, WAITING or CONSOLE).
`Killing`	A request was made to kill the process and the ProcessService has honored that request.
`LockWait`	The process cannot obtain a process lock and is waiting for one to be released.
`Modified`	The parameter list of a process in a chain definition has been modified
`Never`	Process is not scheduled to start within the next two years.
`New`	The process has been submitted, but not yet validated.
`OnChange`	On-change actions for this process are being executed.
`Overdue`	The process did not run in the first time window opened after the process start time
`PostRunning`	Post-Running actions for this process are being executed.
`PreRunning`	Pre-running actions for this process are being executed.
`Queued`	The start time is known, but the process cannot be executed, yet.
`QueueHeld`	The processes Queue has been manually paused
`Running`	The process is being executed by the Service.
`Scheduled`	The process has a valid start time and is waiting for execution
`Skipped`	The process server has not executed the process in a chain due to a pre-condition or the usage of the "Start at specified step" scheduling parameter.
`Uncertain`	The process runner has possibly terminated early, or the process was still running when the process server was restarted.
`Unknown`	The Service was terminated while the process was running (process status was RUNNING, WAITING or CONSOLE).
`Waiting`	The process is waiting for the result of the execution of another process.

Field Summary

Fields
Modifier and Type	Field	Description
`static char`	`AssignedCode`	The char returned from Assigned.getCodeEx().
`static char`	`CanceledCode`	The char returned from Canceled.getCodeEx().
`static char`	`CancelingCode`	The char returned from Canceling.getCodeEx().
`static char`	`ChainedCode`	The char returned from Chained.getCodeEx().
`static char`	`CompletedCode`	The char returned from Completed.getCodeEx().
`static char`	`ConsoleCode`	The char returned from Console.getCodeEx().
`static char`	`ConsoleRestartCode`	The char returned from ConsoleRestart.getCodeEx().
`static char`	`DelayedCode`	The char returned from Delayed.getCodeEx().
`static char`	`DisabledCode`	The char returned from Disabled.getCodeEx().
`static char`	`DispatchedCode`	The char returned from Dispatched.getCodeEx().
`static char`	`ErrorCode`	The char returned from Error.getCodeEx().
`static char`	`EventWaitCode`	The char returned from EventWait.getCodeEx().
`static char`	`HeldCode`	The char returned from Held.getCodeEx().
`static char`	`IgnoredCode`	The char returned from Ignored.getCodeEx().
`static char`	`KilledCode`	The char returned from Killed.getCodeEx().
`static char`	`KillingCode`	The char returned from Killing.getCodeEx().
`static char`	`LockWaitCode`	The char returned from LockWait.getCodeEx().
`static char`	`ModifiedCode`	The char returned from Modified.getCodeEx().
`static char`	`NeverCode`	The char returned from Never.getCodeEx().
`static char`	`NewCode`	The char returned from New.getCodeEx().
`static char`	`OnChangeCode`	The char returned from OnChange.getCodeEx().
`static char`	`OverdueCode`	The char returned from Overdue.getCodeEx().
`static char`	`PostRunningCode`	The char returned from PostRunning.getCodeEx().
`static char`	`PreRunningCode`	The char returned from PreRunning.getCodeEx().
`static char`	`QueuedCode`	The char returned from Queued.getCodeEx().
`static char`	`QueueHeldCode`	The char returned from QueueHeld.getCodeEx().
`static char`	`RunningCode`	The char returned from Running.getCodeEx().
`static char`	`ScheduledCode`	The char returned from Scheduled.getCodeEx().
`static char`	`SkippedCode`	The char returned from Skipped.getCodeEx().
`static char`	`UncertainCode`	The char returned from Uncertain.getCodeEx().
`static char`	`UnknownCode`	The char returned from Unknown.getCodeEx().
`static char`	`WaitingCode`	The char returned from Waiting.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.
`JobStatusState`	`getState()`
`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 JobStatus`	`safeValueOf(String value)`	Helper function to return the JobStatus represented by `value`.
`static JobStatus`	`valueOf(char code)`	Helper function to return the JobStatus represented by code.
`static JobStatus`	`valueOf(Character code)`	Helper function to return the JobStatus represented by code.
`static JobStatus`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static JobStatus`	`valueOfCode(String code)`	Helper function to return the JobStatus represented by code.
`static JobStatus[]`	`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
  - New
```
public static final JobStatus New
```
    The process has been submitted, but not yet validated.
  - Chained
```
public static final JobStatus Chained
```
    A chain is requested and all processes in the chain have been created and are awaiting execution
  - Skipped
```
public static final JobStatus Skipped
```
    The process server has not executed the process in a chain due to a pre-condition or the usage of the "Start at specified step" scheduling parameter.
  - Disabled
```
public static final JobStatus Disabled
```
    The process server will not execute the process in a chain due to a manual request of the user.
  - Ignored
```
public static final JobStatus Ignored
```
    This process was ignored as a result of being Disabled when the chain was called.
  - Delayed
```
public static final JobStatus Delayed
```
    The child process is waiting for the parent process to finish
  - Never
```
public static final JobStatus Never
```
    Process is not scheduled to start within the next two years. This can occur due to conflicting time windows or time window elements, if the Process Server is not running, or if the Queue is closed.
  - Overdue
```
public static final JobStatus Overdue
```
    The process did not run in the first time window opened after the process start time
  - QueueHeld
```
public static final JobStatus QueueHeld
```
    The processes Queue has been manually paused
  - Scheduled
```
public static final JobStatus Scheduled
```
    The process has a valid start time and is waiting for execution
  - ConsoleRestart
```
public static final JobStatus ConsoleRestart
```
    An operator message needs to be replied to in order to decide what to do with this process
  - Held
```
public static final JobStatus Held
```
    The execution of the process has been manually paused.
  - EventWait
```
public static final JobStatus EventWait
```
    The process is waiting for an Event to be raised.
  - LockWait
```
public static final JobStatus LockWait
```
    The process cannot obtain a process lock and is waiting for one to be released.
  - Queued
```
public static final JobStatus Queued
```
    The start time is known, but the process cannot be executed, yet.
  - Dispatched
```
public static final JobStatus Dispatched
```
    The process has been dispatched to a Service, but the Service has not yet started the process.
  - Modified
```
public static final JobStatus Modified
```
    The parameter list of a process in a chain definition has been modified
  - OnChange
```
public static final JobStatus OnChange
```
    On-change actions for this process are being executed.
  - PreRunning
```
public static final JobStatus PreRunning
```
    Pre-running actions for this process are being executed.
  - PostRunning
```
public static final JobStatus PostRunning
```
    Post-Running actions for this process are being executed.
  - Running
```
public static final JobStatus Running
```
    The process is being executed by the Service.
  - Assigned
```
public static final JobStatus Assigned
```
    The process has been accepted by the Service and a process has been created in the remote system, but it has not been started yet.
  - Console
```
public static final JobStatus Console
```
    The process has issued an OperatorMessage to the Messages monitor and is waiting for a reply.
  - Waiting
```
public static final JobStatus Waiting
```
    The process is waiting for the result of the execution of another process.
  - Killing
```
public static final JobStatus Killing
```
    A request was made to kill the process and the ProcessService has honored that request.
  - Canceling
```
public static final JobStatus Canceling
```
    A request was made to cancel the process and the ProcessService has honored that request.
  - Unknown
```
public static final JobStatus Unknown
```
    The Service was terminated while the process was running (process status was RUNNING, WAITING or CONSOLE).
  - Uncertain
```
public static final JobStatus Uncertain
```
    The process runner has possibly terminated early, or the process was still running when the process server was restarted. There may be an accurate termination message for the process waiting to be processed. If there is, the process will go into the appropriate state. Otherwise it will go into status Unknown after a timeout.
  - Completed
```
public static final JobStatus Completed
```
    Process execution finished successfully.
  - Error
```
public static final JobStatus Error
```
    The execution of the process failed.
  - Killed
```
public static final JobStatus Killed
```
    The process was terminated while it was running (process status was RUNNING, WAITING or CONSOLE).
  - Canceled
```
public static final JobStatus Canceled
```
    The process was terminated before execution commenced.
- Field Detail
  - NewCode
```
public static final char NewCode
```
    The char returned from New.getCodeEx().
    
    See Also:
    
    New, Constant Field Values
  - ChainedCode
```
public static final char ChainedCode
```
    The char returned from Chained.getCodeEx().
    
    See Also:
    
    Chained, Constant Field Values
  - SkippedCode
```
public static final char SkippedCode
```
    The char returned from Skipped.getCodeEx().
    
    See Also:
    
    Skipped, Constant Field Values
  - DisabledCode
```
public static final char DisabledCode
```
    The char returned from Disabled.getCodeEx().
    
    See Also:
    
    Disabled, Constant Field Values
  - IgnoredCode
```
public static final char IgnoredCode
```
    The char returned from Ignored.getCodeEx().
    
    See Also:
    
    Ignored, Constant Field Values
  - DelayedCode
```
public static final char DelayedCode
```
    The char returned from Delayed.getCodeEx().
    
    See Also:
    
    Delayed, Constant Field Values
  - NeverCode
```
public static final char NeverCode
```
    The char returned from Never.getCodeEx().
    
    See Also:
    
    Never, Constant Field Values
  - OverdueCode
```
public static final char OverdueCode
```
    The char returned from Overdue.getCodeEx().
    
    See Also:
    
    Overdue, Constant Field Values
  - QueueHeldCode
```
public static final char QueueHeldCode
```
    The char returned from QueueHeld.getCodeEx().
    
    See Also:
    
    QueueHeld, Constant Field Values
  - ScheduledCode
```
public static final char ScheduledCode
```
    The char returned from Scheduled.getCodeEx().
    
    See Also:
    
    Scheduled, Constant Field Values
  - ConsoleRestartCode
```
public static final char ConsoleRestartCode
```
    The char returned from ConsoleRestart.getCodeEx().
    
    See Also:
    
    ConsoleRestart, Constant Field Values
  - HeldCode
```
public static final char HeldCode
```
    The char returned from Held.getCodeEx().
    
    See Also:
    
    Held, Constant Field Values
  - EventWaitCode
```
public static final char EventWaitCode
```
    The char returned from EventWait.getCodeEx().
    
    See Also:
    
    EventWait, Constant Field Values
  - LockWaitCode
```
public static final char LockWaitCode
```
    The char returned from LockWait.getCodeEx().
    
    See Also:
    
    LockWait, Constant Field Values
  - QueuedCode
```
public static final char QueuedCode
```
    The char returned from Queued.getCodeEx().
    
    See Also:
    
    Queued, Constant Field Values
  - DispatchedCode
```
public static final char DispatchedCode
```
    The char returned from Dispatched.getCodeEx().
    
    See Also:
    
    Dispatched, Constant Field Values
  - ModifiedCode
```
public static final char ModifiedCode
```
    The char returned from Modified.getCodeEx().
    
    See Also:
    
    Modified, Constant Field Values
  - OnChangeCode
```
public static final char OnChangeCode
```
    The char returned from OnChange.getCodeEx().
    
    See Also:
    
    OnChange, Constant Field Values
  - PreRunningCode
```
public static final char PreRunningCode
```
    The char returned from PreRunning.getCodeEx().
    
    See Also:
    
    PreRunning, Constant Field Values
  - PostRunningCode
```
public static final char PostRunningCode
```
    The char returned from PostRunning.getCodeEx().
    
    See Also:
    
    PostRunning, Constant Field Values
  - RunningCode
```
public static final char RunningCode
```
    The char returned from Running.getCodeEx().
    
    See Also:
    
    Running, Constant Field Values
  - AssignedCode
```
public static final char AssignedCode
```
    The char returned from Assigned.getCodeEx().
    
    See Also:
    
    Assigned, Constant Field Values
  - ConsoleCode
```
public static final char ConsoleCode
```
    The char returned from Console.getCodeEx().
    
    See Also:
    
    Console, Constant Field Values
  - WaitingCode
```
public static final char WaitingCode
```
    The char returned from Waiting.getCodeEx().
    
    See Also:
    
    Waiting, Constant Field Values
  - KillingCode
```
public static final char KillingCode
```
    The char returned from Killing.getCodeEx().
    
    See Also:
    
    Killing, Constant Field Values
  - CancelingCode
```
public static final char CancelingCode
```
    The char returned from Canceling.getCodeEx().
    
    See Also:
    
    Canceling, Constant Field Values
  - UnknownCode
```
public static final char UnknownCode
```
    The char returned from Unknown.getCodeEx().
    
    See Also:
    
    Unknown, Constant Field Values
  - UncertainCode
```
public static final char UncertainCode
```
    The char returned from Uncertain.getCodeEx().
    
    See Also:
    
    Uncertain, Constant Field Values
  - CompletedCode
```
public static final char CompletedCode
```
    The char returned from Completed.getCodeEx().
    
    See Also:
    
    Completed, Constant Field Values
  - ErrorCode
```
public static final char ErrorCode
```
    The char returned from Error.getCodeEx().
    
    See Also:
    
    Error, Constant Field Values
  - KilledCode
```
public static final char KilledCode
```
    The char returned from Killed.getCodeEx().
    
    See Also:
    
    Killed, Constant Field Values
  - CanceledCode
```
public static final char CanceledCode
```
    The char returned from Canceled.getCodeEx().
    
    See Also:
    
    Canceled, Constant Field Values
- Method Detail
  - values
```
public static JobStatus[] 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 (JobStatus c : JobStatus.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static JobStatus 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
  - getState
```
public JobStatusState getState()
```
  - valueOfCode
```
public static JobStatus valueOfCode(String code)
```
    Helper function to return the JobStatus 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 JobStatus
    
    Returns:
    
    The JobStatus corresponding to code, or null, if code is null, longer than one character, or not a valid code
  - safeValueOf
```
public static JobStatus safeValueOf(String value)
```
    Helper function to return the JobStatus represented by value. If value is null, or not a valid JobStatus 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 JobStatus corresponding to value, or null, if value is null, or not a valid enumeration
    
    See Also:
    
    valueOf(String)
  - valueOf
```
public static JobStatus valueOf(Character code)
```
    Helper function to return the JobStatus represented by code. If code is null, or not a valid JobStatus code then this method will return null.
    
    Parameters:
    
    code - Character that is one of the codes for HandlerAction
    
    Returns:
    
    The JobStatus corresponding to code, or null, if code is null, or not a valid code
  - valueOf
```
public static JobStatus valueOf(char code)
```
    Helper function to return the JobStatus represented by code. If code is not a valid JobStatus code then this method will return null.
    
    Parameters:
    
    code - char that is one of the codes for HandlerAction
    
    Returns:
    
    The JobStatus 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<JobStatus>
    
    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<JobStatus,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<JobStatus>
    
    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<JobStatus,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<JobStatus,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<JobStatus,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<JobStatus>
    
    Returns:
    
    the database code for the enumeration

Enum JobStatus

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

New

Chained

Skipped

Disabled

Ignored

Delayed

Never

Overdue

QueueHeld

Scheduled

ConsoleRestart

Held

EventWait

LockWait

Queued

Dispatched

Modified

OnChange

PreRunning

PostRunning

Running

Assigned

Console

Waiting

Killing

Canceling

Unknown

Uncertain

Completed

Error

Killed

Canceled

Field Detail

NewCode

ChainedCode

SkippedCode

DisabledCode

IgnoredCode

DelayedCode

NeverCode

OverdueCode

QueueHeldCode

ScheduledCode

ConsoleRestartCode

HeldCode

EventWaitCode

LockWaitCode

QueuedCode

DispatchedCode

ModifiedCode

OnChangeCode

PreRunningCode

PostRunningCode

RunningCode

AssignedCode

ConsoleCode

WaitingCode

KillingCode

CancelingCode

UnknownCode

UncertainCode

CompletedCode

ErrorCode

KilledCode

CanceledCode

Method Detail

values

valueOf

getState

valueOfCode

safeValueOf