openconnector

Enum Result.Status

java.lang.Object

java.lang.Enum<Result.Status>

openconnector.Result.Status

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Result.Status>

Enclosing class:

Result

public static enum Result.Status
extends java.lang.Enum<Result.Status>

The set of possible result status codes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Committed Indicates that the request was fully processed and the changes are known to have been made.
Failed Indicates that the request was not processed due to a fatal error.
Queued Indicates that the request was accepted and passed validation, but it was given to another system and we do not know when it will be committed.
Retry Indicates that the request was not processed due to a non fatal error and that it should be retried at a later time.

Method Summary

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

Queued

public static final Result.Status Queued

Indicates that the request was accepted and passed validation, but it was given to another system and we do not know when it will be committed. If possible the connector should also return a token for tracking.

This is the default status, if no result object is returned or if the result object is missing a status, it can be assumed to have been queued.

Committed

public static final Result.Status Committed

Indicates that the request was fully processed and the changes are known to have been made. The caller can use this to immediately update an external model to reflect the changes rather than waiting for a later aggregation.

Failed

public static final Result.Status Failed

Indicates that the request was not processed due to a fatal error. The connector should save one or more messages on the message list.

Retry

public static final Result.Status Retry

Indicates that the request was not processed due to a non fatal error and that it should be retried at a later time. The connector can also set the retryInterval property to indicate the preferred wait time.

Method Detail

values

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

Returns:

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

valueOf

public static Result.Status 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

java.lang.NullPointerException - if the argument is null