uk.co.visalia.brightpearl.apiclient.multimessage

Class MultiResponseBuilder

java.lang.Object

uk.co.visalia.brightpearl.apiclient.multimessage.MultiResponseBuilder

public class MultiResponseBuilder
extends Object

A builder used to create immutable instances of MultiResponse. Intended for internal use only.

Method Summary

Methods

Modifier and Type	Method and Description
MultiResponse	build() Constructs the immutable MultiResponse instance.
static MultiResponseBuilder	newMultiResponse() Returns a new builder instance used to create immutable MultiResponse instances
MultiResponseBuilder	withServiceResponseMap(Map<String,ServiceResponse> serviceResponseMap) Set the results of individual executed requests as a map of request unique ID to response object.
MultiResponseBuilder	withStatus(int status) Set the HTTP response code for the multimessage request.
MultiResponseBuilder	withUnprocessedRequestIds(List<String> unprocessedRequestIds) Set the list of unique request IDs that were not executed due to a failured.

Methods inherited from class java.lang.Object

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

Method Detail

newMultiResponse

public static MultiResponseBuilder newMultiResponse()

Returns a new builder instance used to create immutable MultiResponse instances

Returns:

new builder instance.

build

public MultiResponse build()

Constructs the immutable MultiResponse instance.

Returns:

a MultiResponse instance.

withStatus

public MultiResponseBuilder withStatus(int status)

Set the HTTP response code for the multimessage request.

Parameters:

status - response code for the multimessage request.

Returns:

builder instance for method chaining.

withServiceResponseMap

public MultiResponseBuilder withServiceResponseMap(Map<String,ServiceResponse> serviceResponseMap)

Set the results of individual executed requests as a map of request unique ID to response object.

Parameters:

serviceResponseMap - map of responses for executed requests.

Returns:

builder instance for method chaining.

withUnprocessedRequestIds

public MultiResponseBuilder withUnprocessedRequestIds(List<String> unprocessedRequestIds)

Set the list of unique request IDs that were not executed due to a failured.

Parameters:

unprocessedRequestIds - unique IDs of requests that were not executed.

Returns:

builder instance for method chaining.