Skip navigation links

oracle.as.scheduler
Enum State

java.lang.Object
java.lang.Enum<State>
oracle.as.scheduler.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<State>

public enum State

extends java.lang.Enum<State>

Enumeration of ESS request terminal states.

Enum Constant Summary

BLOCKED
Request is blocked by one or more incompatible requests.

CANCELLED
The request was cancelled.

CANCELLING
The request has been cancelled and is awaiting acknowledgement.

COMPLETED
Request has completed and post-processing has commenced.

ERROR
The request ran and resulted in error.

ERROR_AUTO_RETRY
The request ran, resulted in an error, and is eligible for automatic retry.

ERROR_MANUAL_RECOVERY
The request requires manual intervention in order to be retried or go to a terminal state.

EXPIRED
The request expired before it could be processed.

FINISHED
The request, and all child requests, are finished.

HOLD
Request has been explicitly held.

PAUSED
The request paused for sub-request completion.

PENDING_VALIDATION
The request has been submitted but not validated.

READY
Request has been dispatched and is awaiting processing.

RUNNING
Request is being processed.

SCHEDULE_ENDED
The schedule for the request has ended, or a request expiration time specified at request submission has been reached.

SUCCEEDED
The request ran and was successful.

UNKNOWN
Unknown or invalid state.

VALIDATION_FAILED
The request was submitted but validation failed.

WAIT
Request is awaiting dispatch.

WARNING
The request ran and resulted in a warning.

Method Summary

static State	from(javax.management.openmbean.CompositeData cd)
static State	fromString(java.lang.String stateStr) Converts a stringified state into a State object.
static State	getState(int value) Returns the state for the numeric value specified.
static java.util.EnumSet<State>	getTerminalStates() Returns a set of the terminal states based on the value returned by State.isTerminal.
boolean	isTerminal() Used to determine if the state is a terminal state.
javax.management.openmbean.CompositeData	toCompositeData(javax.management.openmbean.CompositeType ct)
static javax.management.openmbean.CompositeType	toCompositeType() Returns the CompositeType that describes this model specific class
java.lang.String	toString(java.util.Locale locale)
int	value() Returns the numeric value for the state.
static State	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static State[]	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

Enum Constant 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

Request has completed and post-processing has commenced.

BLOCKED

public static final State BLOCKED

Request 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

The request ran and resulted in error.

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 validated.

VALIDATION_FAILED

public static final State VALIDATION_FAILED

The request was submitted but validation failed.

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 or trigger-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 or trigger-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()

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 (State c : State.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static State valueOf(java.lang.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

java.lang.NullPointerException - if the argument is null

isTerminal

public boolean isTerminal()

Used to determine if the state is a terminal state.

Returns:

true if terminal, false otherwise.

value

public int value()

Returns the numeric value for the state.

Returns:

value for this state.

getState

public static State getState(int value)

Returns the state for the numeric value specified.

Parameters:

value - to convert to state.

Returns:

associated state.

getTerminalStates

public static java.util.EnumSet<State> getTerminalStates()

Returns a set of the terminal states based on the value returned by State.isTerminal.

Returns:

a set of the terminal states

toCompositeType

public static javax.management.openmbean.CompositeType toCompositeType()

Returns the CompositeType that describes this model specific class

toCompositeData

public javax.management.openmbean.CompositeData toCompositeData(javax.management.openmbean.CompositeType ct)

from

public static State from(javax.management.openmbean.CompositeData cd)
                  throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

fromString

public static State fromString(java.lang.String stateStr)

Converts a stringified state into a State object.

Parameters:

stateStr -

Returns:

the state derived from stateStr or State.UNKNOWN if the conversion could not be made.

toString

public java.lang.String toString(java.util.Locale locale)

Skip navigation links