uk.co.visalia.brightpearl.apiclient.request

Class ServiceWriteRequest<T>

java.lang.Object

uk.co.visalia.brightpearl.apiclient.request.AbstractServiceRequest<T>

uk.co.visalia.brightpearl.apiclient.request.ServiceWriteRequest<T>

Type Parameters:

T - A placeholder for the type expected in the response, avoiding the requirement to cast responses. This is not linked to the Type set on a request so a ClassCastException is possible if the type is set incorrectly.

public class ServiceWriteRequest<T>
extends AbstractServiceRequest<T>

Represents a write request to be made to the Brightpearl API. Extends AbstractServiceRequest, adding the attributes unique to a write request. This is currently only the entity to be serialised as JSON and sent as the request body.

Request instances are intended to be immutable to avoid modification while a request is being constructed, however the enclosed entity cannot be protected from external modification. Avoid modifying entities after including them in a request.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getEntity() The entity to be serialised as JSON and sent as the request body.

Methods inherited from class uk.co.visalia.brightpearl.apiclient.request.AbstractServiceRequest

getMethod, getParams, getPath, getResponseType, getRuid, getService

Methods inherited from class java.lang.Object

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

Method Detail

getEntity

public Object getEntity()

The entity to be serialised as JSON and sent as the request body.

Returns:

the request entity object.