uk.co.visalia.brightpearl.apiclient.multimessage

Class ServiceResponse<T>

java.lang.Object

uk.co.visalia.brightpearl.apiclient.multimessage.ServiceResponse<T>

Type Parameters:

T - placeholder for the response type.

public final class ServiceResponse<T>
extends Object

Contains the response for an individual request executed in a multimessage batch.

Method Summary

Methods

Modifier and Type	Method and Description
List<ServiceError>	getErrors() Returns any errors included in the response body.
T	getResponse() Returns the parsed entity parsed from the response element of the JSON, in the type expected for the request sent.
String	getRuid() Returns the unique ID of the request sent.
int	getStatus() Returns the HTTP status code received.
boolean	isSuccess() Returns false if there were errors in the response body, regardless of the status code, or there was an error parsing the response for this individual request.

Methods inherited from class java.lang.Object

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

Method Detail

getRuid

public String getRuid()

Returns the unique ID of the request sent.

getStatus

public int getStatus()

Returns the HTTP status code received.

Returns:

HTTP status code of the individual response.

isSuccess

public boolean isSuccess()

Returns false if there were errors in the response body, regardless of the status code, or there was an error parsing the response for this individual request.

Returns:

true if the request was successful.

getErrors

public List<ServiceError> getErrors()

Returns any errors included in the response body.

Returns:

a list of ServiceErrors from the response.

getResponse

public T getResponse()

Returns the parsed entity parsed from the response element of the JSON, in the type expected for the request sent. This method will throw an exception if the Brightpearl API returned error messages or the response for the individual request could not be parsed, mimicking the behaviour of the BrightpearlApiClient and BrightpearlLegacyApiSession classes. To avoid exceptions, call isSuccess() before this method.

Returns:

The entity parsed from the response element of the JSON body received.