uk.co.visalia.brightpearl.apiclient.multimessage

Class MultiRequest

java.lang.Object

uk.co.visalia.brightpearl.apiclient.multimessage.MultiRequest

public final class MultiRequest
extends Object

Wraps a set of write requests together with a OnFailOption and a ProcessingMode to define a multimessage request for execution with the Brightpearl API. Instances are immutable and may be constructed using MultiRequestBuilder. For further information please see the link below.

See Also:

http://www.brightpearl.com/developer/latest/concept/multi-message.html

Method Summary

Methods

Modifier and Type	Method and Description
OnFailOption	getOnFailOption() The on fail option (STOP or CONTINUE) set on the request, defining whether remaining requests should still be executed when one fails.
ProcessingMode	getProcessingMode() The processing mode option (SEQUENTIAL or PARALLEL) set on the request, which defines whether requests should be executed in serial or in parallel by the Brightpearl multimessage API.
ServiceWriteRequest	getRequest(String id) Returns an individual request by its unique ID.
List<ServiceWriteRequest>	getRequests() The list of requests included in the multimessage batch.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getOnFailOption

public OnFailOption getOnFailOption()

The on fail option (STOP or CONTINUE) set on the request, defining whether remaining requests should still be executed when one fails.

Returns:

the on fail option selected.

getProcessingMode

public ProcessingMode getProcessingMode()

The processing mode option (SEQUENTIAL or PARALLEL) set on the request, which defines whether requests should be executed in serial or in parallel by the Brightpearl multimessage API.

Returns:

the processing mode option selected.

getRequests

public List<ServiceWriteRequest> getRequests()

The list of requests included in the multimessage batch.

Returns:

included requests for execution.

getRequest

public ServiceWriteRequest getRequest(String id)

Returns an individual request by its unique ID.

Parameters:

id - a request unique ID.

Returns:

the request with the given ID, null if it is not found.