org.rhq.core.clientapi.agent.operation

Enum CancelResults.InterruptedState

java.lang.Object

java.lang.Enum<CancelResults.InterruptedState>

org.rhq.core.clientapi.agent.operation.CancelResults.InterruptedState

All Implemented Interfaces:

Serializable, Comparable<CancelResults.InterruptedState>

Enclosing class:

CancelResults

public static enum CancelResults.InterruptedState
extends Enum<CancelResults.InterruptedState>

Defines the different states an operation job can be in when being canceled.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FINISHED The operation job has already finished.
QUEUED The operation job was queued but not yet handed off to the plugin to be invoked.
RUNNING The operation job was running at the time it was canceled.
UNKNOWN The operation invocation's job ID is not known and therefore nothing can be canceled.

Method Summary

Methods

Modifier and Type	Method and Description
static CancelResults.InterruptedState	valueOf(String name) Returns the enum constant of this type with the specified name.
static CancelResults.InterruptedState[]	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

FINISHED

public static final CancelResults.InterruptedState FINISHED

The operation job has already finished. This is not cancelable since the operation has already been invoked and it completed, i.e. there is nothing to cancel.

RUNNING

public static final CancelResults.InterruptedState RUNNING

The operation job was running at the time it was canceled. This means the plugin was currently performing the operation and thus the operation may or may not be cancelable (depends on the plugin implementation as to whether it allows the invocation to be canceled).

QUEUED

public static final CancelResults.InterruptedState QUEUED

The operation job was queued but not yet handed off to the plugin to be invoked. This is normally a state that is always cancelable since the operation has not actually been invoked yet.

UNKNOWN

public static final CancelResults.InterruptedState UNKNOWN

The operation invocation's job ID is not known and therefore nothing can be canceled.

Method Detail

values

public static CancelResults.InterruptedState[] 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 (CancelResults.InterruptedState c : CancelResults.InterruptedState.values())
    System.out.println(c);

Returns:

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

valueOf

public static CancelResults.InterruptedState 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