uws.job
Enum ExecutionPhase

java.lang.Object
  java.lang.Enum<ExecutionPhase>
      uws.job.ExecutionPhase

All Implemented Interfaces:

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

public enum ExecutionPhase
extends java.lang.Enum<ExecutionPhase>

A job is treated as a state machine where the Execution Phase is the job state. The phases are:

• PENDING: the job is accepted by the service but not yet committed for execution by the client. In this state, the job quote can be read and evaluated. This is the state into which a job enters when it is first created.
• QUEUED: the job is committed for execution by the client but the service has not yet assigned it to a processor. No Results are produced in this phase.
• EXECUTING: the job has been assigned to a processor. Results may be produced at any time during this phase.
• COMPLETED: the execution of the job is over. The Results may be collected.
• ERROR: the job failed to complete. No further work will be done nor Results produced. Results may be unavailable or available but invalid; either way the Results should not be trusted.
• ABORTED: the job has been manually aborted by the user, or the system has aborted the job due to lack of or overuse of resources.
• UNKNOWN: the job is in an unknown state.
• HELD: The job is HELD pending execution and will not automatically be executed (cf pending).
• SUSPENDED: The job has been suspended by the system during execution. This might be because of temporary lack of resource. The UWS will automatically resume the job into the EXECUTING phase without any intervention when resource becomes available.

Version:

02/2011

Author:

Grégory Mantelet (CDS)

See Also:

AbstractJob

Enum Constant Summary

ABORTED

COMPLETED

ERROR

EXECUTING

HELD

PENDING

QUEUED

SUSPENDED

UNKNOWN

Method Summary

static ExecutionPhase	getPhase(java.lang.String phStr)
static java.lang.String	getStr(ExecutionPhase ph)
static ExecutionPhase	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ExecutionPhase[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PENDING

public static final ExecutionPhase PENDING

QUEUED

public static final ExecutionPhase QUEUED

EXECUTING

public static final ExecutionPhase EXECUTING

COMPLETED

public static final ExecutionPhase COMPLETED

ERROR

public static final ExecutionPhase ERROR

ABORTED

public static final ExecutionPhase ABORTED

UNKNOWN

public static final ExecutionPhase UNKNOWN

HELD

public static final ExecutionPhase HELD

SUSPENDED

public static final ExecutionPhase SUSPENDED

Method Detail

values

public static final ExecutionPhase[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(ExecutionPhase c : ExecutionPhase.values())
        System.out.println(c);

Returns:

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

valueOf

public static ExecutionPhase 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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

getStr

public static final java.lang.String getStr(ExecutionPhase ph)

getPhase

public static final ExecutionPhase getPhase(java.lang.String phStr)