com.sap.cloud.sdk.datamodel.odata.client.request

Class ODataRequestBatch

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestGeneric

com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestBatch

All Implemented Interfaces:

ODataRequestExecutable

@Beta
public class ODataRequestBatch
extends ODataRequestGeneric

The OData Batch request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ODataRequestBatch.Changeset The Changeset representation of the OData Batch operation.

Field Summary

Fields inherited from class com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestGeneric

DEFAULT_FORMAT, servicePath

Constructor Summary

Constructors

Constructor and Description
ODataRequestBatch(String servicePath, ODataProtocol protocol) Default constructor for OData Batch request.
ODataRequestBatch(String servicePath, ODataProtocol protocol, Supplier<UUID> uuidProvider) Default constructor for OData Batch request.

Method Summary

Modifier and Type	Method and Description
ODataRequestBatch	addFunction(ODataRequestFunction request) Add an OData Function request to the current OData Batch request.
ODataRequestBatch	addRead(ODataRequestRead request) Add an OData Read request to the current OData Batch request.
ODataRequestBatch	addReadByKey(ODataRequestReadByKey request) Add an OData Read-By-Key request to the current OData Batch request.
ODataRequestBatch.Changeset	beginChangeset() Instantiate a new changeset to the current OData Batch request.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
ODataRequestResultMultipartGeneric	execute(org.apache.http.client.HttpClient httpClient) Execute the OData request with the provided HttpClient reference.
UUID	getBatchUuid()
AtomicInteger	getContentId()
protected Map<String,String>	getHeaders() Map of HTTP header key-values which are added to the OData request.
URI	getRelativeUri() Get the static request URI of the OData resource.
List<com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestBatch.BatchItem>	getRequests()
Supplier<UUID>	getUuidProvider()
int	hashCode()

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestGeneric

addHeader, addHeaderIfAbsent, addListener, addQueryParameter, getListeners, getProtocol, getQueryParameters, getRequestQuery, getServicePath, setCsrfTokenRetriever, setResponseFormat, tryExecute, tryExecuteWithCsrfToken

Methods inherited from class java.lang.Object

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

Constructor Detail

ODataRequestBatch

public ODataRequestBatch(@Nonnull
                         String servicePath,
                         @Nonnull
                         ODataProtocol protocol)

Default constructor for OData Batch request.

Parameters:

servicePath - The OData service path

protocol - The OData protocol

ODataRequestBatch

public ODataRequestBatch(@Nonnull
                         String servicePath,
                         @Nonnull
                         ODataProtocol protocol,
                         @Nonnull
                         Supplier<UUID> uuidProvider)

Default constructor for OData Batch request.

Parameters:

servicePath - The OData service path

protocol - The OData protocol

uuidProvider - A generic UUID provider, customizable for testing

Method Detail

getRelativeUri

@Nonnull
public URI getRelativeUri()

Description copied from class: ODataRequestGeneric

Get the static request URI of the OData resource.

Specified by:

getRelativeUri in class ODataRequestGeneric

Returns:

The String representation of the request URI.

addRead

@Nonnull
public ODataRequestBatch addRead(@Nonnull
                                          ODataRequestRead request)

Add an OData Read request to the current OData Batch request.

Parameters:

request - The Read request.

Returns:

The Batch request fluent helper instance.

addReadByKey

@Nonnull
public ODataRequestBatch addReadByKey(@Nonnull
                                               ODataRequestReadByKey request)

Add an OData Read-By-Key request to the current OData Batch request.

Parameters:

request - The Read-By-Key request.

Returns:

The Batch request fluent helper instance.

addFunction

@Nonnull
public ODataRequestBatch addFunction(@Nonnull
                                              ODataRequestFunction request)

Add an OData Function request to the current OData Batch request.

Parameters:

request - The Function request.

Returns:

The Batch request fluent helper instance.

beginChangeset

@Nonnull
public ODataRequestBatch.Changeset beginChangeset()

Instantiate a new changeset to the current OData Batch request. As per specification if any data modifying operation fails within one changeset, then the incomplete changes will be reverted.

Returns:

A new Changeset fluent helper instance.

execute

@Nonnull
public ODataRequestResultMultipartGeneric execute(@Nonnull
                                                           org.apache.http.client.HttpClient httpClient)

Description copied from interface: ODataRequestExecutable

Execute the OData request with the provided HttpClient reference.

Parameters:

httpClient - The HttpClient.

Returns:

An OData request result.

getHeaders

@Nonnull
protected Map<String,String> getHeaders()

Description copied from class: ODataRequestGeneric

Map of HTTP header key-values which are added to the OData request.

Overrides:

getHeaders in class ODataRequestGeneric

getRequests

@Nonnull
public List<com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestBatch.BatchItem> getRequests()

getContentId

public AtomicInteger getContentId()

getBatchUuid

public UUID getBatchUuid()

getUuidProvider

public Supplier<UUID> getUuidProvider()

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class ODataRequestGeneric

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class ODataRequestGeneric

hashCode

public int hashCode()

Overrides:

hashCode in class ODataRequestGeneric