uk.co.visalia.brightpearl.apiclient.multimessage

Enum OnFailOption

java.lang.Object

java.lang.Enum<OnFailOption>

uk.co.visalia.brightpearl.apiclient.multimessage.OnFailOption

All Implemented Interfaces:

Serializable, Comparable<OnFailOption>

public enum OnFailOption
extends Enum<OnFailOption>

An instruction to the Brightpearl Multi-Message API that determines what the behaviour should be when one request in a multi-message fails. The default behaviour for this client is to STOP the processing, however when all the requests in a multi-message are independent and one failure does not impact the others, the CONTINUE option may be used.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTINUE Continue processing all requests in a multi-message regardless of failures.
STOP Cancel the processing of subsequent requests in a multi-message batch when one fails.

Method Summary

Methods

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

STOP

public static final OnFailOption STOP

Cancel the processing of subsequent requests in a multi-message batch when one fails. This option cannot be used with the ProcessingMode.PARALLEL processing option.

CONTINUE

public static final OnFailOption CONTINUE

Continue processing all requests in a multi-message regardless of failures.

Method Detail

values

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

Returns:

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

valueOf

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