org.rhq.core.domain.content
Enum ContentRequestStatus

java.lang.Object
  java.lang.Enum<ContentRequestStatus>
      org.rhq.core.domain.content.ContentRequestStatus

All Implemented Interfaces:

Serializable, Comparable<ContentRequestStatus>

public enum ContentRequestStatus
extends Enum<ContentRequestStatus>

Indicates the current state of a request.

Enum Constant Summary

FAILURE
Indicates the agent has responded to this request and indicated a failure occurred in either the agent, plugin container, or plugin itself.

IN_PROGRESS
Indicates the request has been submitted to the agent but we have not yet received a response.

SUCCESS
Indicates the result has been returned from the agent and the plugin was able to execute the actions described by the request.

TIMED_OUT
Indicates the request was successfully sent to the agent, however a response was not received in a timely manner.

Method Summary

String	toString()
static ContentRequestStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static ContentRequestStatus[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

IN_PROGRESS

public static final ContentRequestStatus IN_PROGRESS

Indicates the request has been submitted to the agent but we have not yet received a response. Requests in this state are subject to cleanup if they have been in this state for an extended period of time without a reply from the agent.

SUCCESS

public static final ContentRequestStatus SUCCESS

Indicates the result has been returned from the agent and the plugin was able to execute the actions described by the request.

FAILURE

public static final ContentRequestStatus FAILURE

Indicates the agent has responded to this request and indicated a failure occurred in either the agent, plugin container, or plugin itself. An error message will be provided in the request to further describe the failure.

TIMED_OUT

public static final ContentRequestStatus TIMED_OUT

Indicates the request was successfully sent to the agent, however a response was not received in a timely manner. This state prevents the UI from showing a perpetually in progress request. It is possible that a request may leave this state at a later time if the agent eventually returns with a response on this request.

Method Detail

values

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

Returns:

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

valueOf

public static ContentRequestStatus 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

toString

public String toString()

Overrides:

toString in class Enum<ContentRequestStatus>