State (Oracle Enterprise Scheduler Java API Reference)

java.lang.Object
- java.lang.Enum
- - oracle.as.scheduler.State

All Implemented Interfaces:

Serializable, Comparable
```
public final class State
extends Enum
```
Enum of ESS request states.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static State`	`BLOCKED` Request execution is blocked by one or more incompatible requests.
`static State`	`CANCELLED` The request was cancelled.
`static State`	`CANCELLING` The request has been cancelled and is awaiting acknowledgement.
`static State`	`COMPLETED` Job executable has completed and request post-processing has commenced.
`static State`	`ERROR` Request processing resulted in error.
`static State`	`ERROR_AUTO_RETRY` The request ran, resulted in an error, and is eligible for automatic retry.
`static State`	`ERROR_MANUAL_RECOVERY` The request requires manual intervention in order to be retried or go to a terminal state.
`static State`	`EXPIRED` The request expired before it could be processed.
`static State`	`FINISHED` The request, and all child requests, are finished.
`static State`	`HOLD` Request has been explicitly held.
`static State`	`PAUSED` The request paused for sub-request completion.
`static State`	`PENDING_VALIDATION` The request has been submitted but not yet validated.
`static State`	`READY` Request has been dispatched and is awaiting processing.
`static State`	`RUNNING` Request is being processed.
`static State`	`SCHEDULE_ENDED` The schedule for the request has ended, or a request expiration time specified at request submission has been reached.
`static State`	`SUCCEEDED` The request ran and was successful.
`static State`	`UNKNOWN` Unknown or invalid state.
`static State`	`VALIDATION_FAILED` The request was submitted but failed validation.
`static State`	`WAIT` Request is awaiting dispatch.
`static State`	`WARNING` The request ran and resulted in a warning.

Method Summary

Methods
Modifier and Type	Method and Description
`static State`	`fromString(String stateStr)` Converts a stringified state into a State object.
`static EnumSet`	`getNonTerminalStates()` The set of the non-terminal states based on the value returned by `isTerminal`.
`static State`	`getState(int value)` The State associated with the given numeric value.
`static EnumSet`	`getTerminalStates()` The set of the terminal states based on the value returned by `isTerminal`.
`boolean`	`isTerminal()` Indicates if the state is a terminal state.
`String`	`toString(Locale locale)` Enterprise Manager support to acquire a localized string value.
`int`	`value()` The numeric value associated with the State.
`static State`	`valueOf(String name)`
`static State[]`	`values()`

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - UNKNOWN
```
public static final State UNKNOWN
```
    Unknown or invalid state.
  - WAIT
```
public static final State WAIT
```
    Request is awaiting dispatch.
  - READY
```
public static final State READY
```
    Request has been dispatched and is awaiting processing.
  - RUNNING
```
public static final State RUNNING
```
    Request is being processed.
  - COMPLETED
```
public static final State COMPLETED
```
    Job executable has completed and request post-processing has commenced.
  - BLOCKED
```
public static final State BLOCKED
```
    Request execution is blocked by one or more incompatible requests.
  - HOLD
```
public static final State HOLD
```
    Request has been explicitly held.
  - CANCELLING
```
public static final State CANCELLING
```
    The request has been cancelled and is awaiting acknowledgement.
  - EXPIRED
```
public static final State EXPIRED
```
    The request expired before it could be processed.
  - CANCELLED
```
public static final State CANCELLED
```
    The request was cancelled.
  - ERROR
```
public static final State ERROR
```
    Request processing resulted in error. The job executable may or may not have been run depending on where the error was encountered in processing lifecycle of the request.
  - WARNING
```
public static final State WARNING
```
    The request ran and resulted in a warning.
  - SUCCEEDED
```
public static final State SUCCEEDED
```
    The request ran and was successful.
  - PAUSED
```
public static final State PAUSED
```
    The request paused for sub-request completion.
  - PENDING_VALIDATION
```
public static final State PENDING_VALIDATION
```
    The request has been submitted but not yet validated.
  - VALIDATION_FAILED
```
public static final State VALIDATION_FAILED
```
    The request was submitted but failed validation.
  - SCHEDULE_ENDED
```
public static final State SCHEDULE_ENDED
```
    The schedule for the request has ended, or a request expiration time specified at request submission has been reached.
    This is a non-terminal state for a schedule-based request that indicates that no new child request will be generated. One or more child requests may still be in a non-terminal state.
  - FINISHED
```
public static final State FINISHED
```
    The request, and all child requests, are finished.
    This is a terminal state for a schedule-based request that indicates that all child requests are in a terminal state.
  - ERROR_AUTO_RETRY
```
public static final State ERROR_AUTO_RETRY
```
    The request ran, resulted in an error, and is eligible for automatic retry.
  - ERROR_MANUAL_RECOVERY
```
public static final State ERROR_MANUAL_RECOVERY
```
    The request requires manual intervention in order to be retried or go to a terminal state.
- Method Detail
  - values
```
public static State[] values()
```
  - valueOf
```
public static State valueOf(String name)
```
  - isTerminal
```
public boolean isTerminal()
```
    Indicates if the state is a terminal state.
    
    Returns:
    true if terminal, false otherwise.
  - value
```
public int value()
```
    The numeric value associated with the State.
    
    Returns:
    value for this state.
  - getState
```
public static State getState(int value)
```
    The State associated with the given numeric value.
    
    Parameters:
    value - the value to convert to state.
    
    Returns:
    associated state.
  - getTerminalStates
```
public static EnumSet getTerminalStates()
```
    The set of the terminal states based on the value returned by isTerminal.
    
    Returns:
    a set of the terminal states
  - getNonTerminalStates
```
public static EnumSet getNonTerminalStates()
```
    The set of the non-terminal states based on the value returned by isTerminal.
    
    Returns:
    set of non-terminal states
  - fromString
```
public static State fromString(String stateStr)
```
    Converts a stringified state into a State object.
    
    Parameters:
    stateStr - the string to convert
    
    Returns:
    the state derived from stateStr, or {State.UNKNOWN} if the conversion could not be made.
  - toString
```
public String toString(Locale locale)
```
    Enterprise Manager support to acquire a localized string value.
    
    Parameters:
    locale - the desired locale.
    
    Returns:
    the localized string

Class State

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Field Detail

UNKNOWN

WAIT

READY

RUNNING

COMPLETED

BLOCKED

HOLD

CANCELLING

EXPIRED

CANCELLED

ERROR

WARNING

SUCCEEDED

PAUSED

PENDING_VALIDATION

VALIDATION_FAILED

SCHEDULE_ENDED

FINISHED

ERROR_AUTO_RETRY

ERROR_MANUAL_RECOVERY

Method Detail

values

valueOf

isTerminal

value

getState

getTerminalStates

getNonTerminalStates

fromString

toString