uk.co.visalia.brightpearl.apiclient.multimessage

Class MultiResponse

java.lang.Object

uk.co.visalia.brightpearl.apiclient.multimessage.MultiResponse

public final class MultiResponse
extends Object

Contains the results of a multimessage request. This consists of the status code from the multimessage API, results of each request executed, and a list of unique IDs for the requests that were not executed.

See Also:

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

Method Summary

Methods

Modifier and Type	Method and Description
<T> ServiceResponse<T>	getServiceResponse(ServiceWriteRequest<T> request) Fetches the response for an individual request included in the multimessage, using the request's unique ID.
ServiceResponse	getServiceResponse(String ruid) Fetches the response for an individual request included in the multimessage, using the request's unique ID.
int	getStatus() Returns the status code for the multimessage container request.
List<String>	getUnprocessedRequestRuids() Returns the list of unique request IDs that were not processed due to earlier failures.

Methods inherited from class java.lang.Object

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

Method Detail

getStatus

public int getStatus()

Returns the status code for the multimessage container request. If the request succeeded, the response code will be 200 if all individual messages received 200 responses, and 207 if any did not. Regardless of this status code, the getUnprocessedRequestRuids() collection and the results of each individual request from getServiceResponse(String) should be inspected to confirm the requests were all successfully executed.

Returns:

status code of the multimessage request.

getServiceResponse

public <T> ServiceResponse<T> getServiceResponse(ServiceWriteRequest<T> request)

Fetches the response for an individual request included in the multimessage, using the request's unique ID. This is equivalent to passing the ID to getServiceResponse(String) but hides casting of the response to the correct generic type.

Type Parameters:

T - Type of response entity expected for the request.

Parameters:

request - A request sent in the multi-message.

Returns:

The response received for the individual request, or null if the ID is either not valid or the request was not processed due to an earlier failure.

getServiceResponse

public ServiceResponse getServiceResponse(String ruid)

Fetches the response for an individual request included in the multimessage, using the request's unique ID. The response is untyped and the entity within may be casted to the expected type.

Parameters:

ruid - ID of a request sent in the multi-message.

Returns:

The response received for the individual request, or null if the ID is either not valid or the request was not processed due to an earlier failure.

getUnprocessedRequestRuids

public List<String> getUnprocessedRequestRuids()

Returns the list of unique request IDs that were not processed due to earlier failures.

Returns:

unprocessed request IDs.