uk.co.visalia.brightpearl.apiclient.multimessage

Class MultiRequestBuilder

java.lang.Object

uk.co.visalia.brightpearl.apiclient.multimessage.MultiRequestBuilder

public final class MultiRequestBuilder
extends Object

A builder used to create immutable instances of MultiRequest.

See Also:

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

Method Summary

Methods

Modifier and Type	Method and Description
MultiRequest	build() Constructs the immutable MultiRequest instance.
static MultiRequestBuilder	newMultiRequest() Returns a new builder instance used to create immutable MultiRequest instances
MultiRequestBuilder	withAddedRequest(ServiceWriteRequest request) Add a request to the multimessage batch.
MultiRequestBuilder	withAddedRequest(ServiceWriteRequestBuilder requestBuilder) Add a request to the multimessage batch.
MultiRequestBuilder	withOnFailOption(OnFailOption onFailOption) Set the on fail option (STOP or CONTINUE) for the request, defining whether remaining requests should still be executed when one fails.
MultiRequestBuilder	withProcessingMode(ProcessingMode processingMode) Set the processing mode option (SEQUENTIAL or PARALLEL) for the request, which defines whether requests should be executed in serial or in parallel by the Brightpearl multimessage API.
MultiRequestBuilder	withRequests(List<ServiceWriteRequest> requests) Set the requests to be added to the multimessage batch, replacing any previously set.

Methods inherited from class java.lang.Object

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

Method Detail

newMultiRequest

public static MultiRequestBuilder newMultiRequest()

Returns a new builder instance used to create immutable MultiRequest instances

Returns:

new builder instance.

build

public MultiRequest build()

Constructs the immutable MultiRequest instance.

Returns:

a MultiRequest instance.

withOnFailOption

public MultiRequestBuilder withOnFailOption(OnFailOption onFailOption)

Set the on fail option (STOP or CONTINUE) for the request, defining whether remaining requests should still be executed when one fails. OnFailOption.STOP cannot be used with ProcessingMode.PARALLEL.

Parameters:

onFailOption - the OnFailOption to be used.

Returns:

builder instance for method chaining.

withProcessingMode

public MultiRequestBuilder withProcessingMode(ProcessingMode processingMode)

Set the processing mode option (SEQUENTIAL or PARALLEL) for the request, which defines whether requests should be executed in serial or in parallel by the Brightpearl multimessage API. ProcessingMode.PARALLEL cannot be used with OnFailOption.STOP.

Parameters:

processingMode - the ProcessingMode to be used.

Returns:

builder instance for method chaining.

withRequests

public MultiRequestBuilder withRequests(List<ServiceWriteRequest> requests)

Set the requests to be added to the multimessage batch, replacing any previously set.

Parameters:

requests - requests to be sent in the batch.

Returns:

builder instance for method chaining.

withAddedRequest

public MultiRequestBuilder withAddedRequest(ServiceWriteRequest request)

Add a request to the multimessage batch.

Parameters:

request - request to be added.

Returns:

builder instance for method chaining.

withAddedRequest

public MultiRequestBuilder withAddedRequest(ServiceWriteRequestBuilder requestBuilder)

Add a request to the multimessage batch. This is a convenience method accepting a builder so its build method does not need to be called.

Parameters:

requestBuilder - builder for a request to be added.

Returns:

builder instance for method chaining.