com.sap.smp.client.odata.store

Interface ODataRequestParamBatch

All Superinterfaces:

ODataRequestParam

All Known Implementing Classes:

ODataRequestParamBatchDefaultImpl

public interface ODataRequestParamBatch
extends ODataRequestParam

Representation for a batch request. A batch request can contain batch items (ODataRequestBatchItem). A batch item can be single read request (ODataRequestParamSingle) or a change set ( ODataRequestChangeSet).

Method Summary

Modifier and Type	Method and Description
void	add(ODataRequestBatchItem request) Adds a batch item to the batch request.
ODataRequestBatchItem	get(int index) Returns the batch item for the given index.
int	size() Returns the number of batch items in this batch request.

Methods inherited from interface com.sap.smp.client.odata.store.ODataRequestParam

getCustomHeaders, getCustomTag, setCustomTag

Method Detail

add

void add(ODataRequestBatchItem request)
  throws ODataException

Adds a batch item to the batch request. Only single read request or change set can be added. Otherwise a ODataException is thrown.

Parameters:

request - batch item. It MUST be non-null, otherwise NullPointerException is thrown. It MUST be a read request or a change set, otherwise ODataException.

Throws:

ODataException - if the request is not a read operation or a change set.

java.lang.NullPointerException - if request parameter is null

size

int size()

Returns the number of batch items in this batch request.

Returns:

number of items

get

ODataRequestBatchItem get(int index)

Returns the batch item for the given index.

Parameters:

index - the index of the item

Returns:

batch item, always non-null. It can be single read request (ODataRequestParamSingle) or a change set ( ODataRequestChangeSet).

Throws:

java.lang.IndexOutOfBoundsException - if the size of the list is not greater than the given index