uk.co.visalia.brightpearl.apiclient.multimessage

Enum ProcessingMode

java.lang.Object

java.lang.Enum<ProcessingMode>

uk.co.visalia.brightpearl.apiclient.multimessage.ProcessingMode

All Implemented Interfaces:

Serializable, Comparable<ProcessingMode>

public enum ProcessingMode
extends Enum<ProcessingMode>

A hint to the Brightpearl API whether the requests in a multi-message are safe to be executed concurrently. The PARALLEL option should only be used when the requests are independent and isolated, and unlikely to compete for the same resources. For example, when POSTing rows to the same order, the PARALLEL option is not suitable, whereas when POSTing order status updates to separate orders, it should be safe.

Neither this client library nor Brightpearl provide guidance or restriction on the use of parallel mode, so care should be taken when using it. At the time of writing, parallel mode has little impact on response times so there may be no compelling reason to use it.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PARALLEL Process the individual requests of a multi-message in parallel.
SEQUENTIAL Process the individual requests of a multi-message in sequence.

Method Summary

Methods

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

PARALLEL

public static final ProcessingMode PARALLEL

Process the individual requests of a multi-message in parallel. This option cannot be used with OnFailOption.STOP.

SEQUENTIAL

public static final ProcessingMode SEQUENTIAL

Process the individual requests of a multi-message in sequence.

Method Detail

values

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

Returns:

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

valueOf

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