com.sap.cloud.sdk.datamodel.odatav4.core

Class BatchResponse

java.lang.Object

com.sap.cloud.sdk.datamodel.odatav4.core.BatchResponse

@Beta
public final class BatchResponse
extends Object

Generic OData service response wrapper for Batch response.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
<T> ActionResponseCollection<T>	getModificationResult(CollectionValueActionRequestBuilder<T> operation) Extract the batch item result for the provided OData request.
<EntityT extends VdmEntity<?>> ModificationResponse<EntityT>	getModificationResult(CreateRequestBuilder<EntityT> operation) Extract the batch item result for the provided OData request.
<EntityT extends VdmEntity<?>> ModificationResponse<EntityT>	getModificationResult(DeleteRequestBuilder<EntityT> operation) Extract the batch item result for the provided OData request.
<T> ActionResponseSingle<T>	getModificationResult(SingleValueActionRequestBuilder<T> operation) Extract the batch item result for the provided OData request.
<EntityT extends VdmEntity<?>> ModificationResponse<EntityT>	getModificationResult(UpdateRequestBuilder<EntityT> operation) Extract the batch item result for the provided OData request.
<T> List<T>	getReadResult(CollectionValueFunctionRequestBuilder<T> operation) Extract the batch item result for the provided OData request.
<T extends VdmEntity<?>> List<T>	getReadResult(GetAllRequestBuilder<T> operation) Extract the batch item result for the provided OData request.
<T extends VdmEntity<?>> T	getReadResult(GetByKeyRequestBuilder<T> operation) Extract the batch item result for the provided OData request.
<T> T	getReadResult(SingleValueFunctionRequestBuilder<T> operation) Extract the batch item result for the provided OData request.
Map<String,Iterable<String>>	getResponseHeaders() Get the response headers.
int	getResponseStatusCode() Get the response status code.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getResponseStatusCode

public int getResponseStatusCode()

Get the response status code.

Returns:

The integer representation of the HTTP status code.

getResponseHeaders

@Nonnull
public Map<String,Iterable<String>> getResponseHeaders()

Get the response headers.

Returns:

The headers of the HTTP status code.

getReadResult

@Nonnull
public <T extends VdmEntity<?>> List<T> getReadResult(@Nonnull
                                                               GetAllRequestBuilder<T> operation)

Extract the batch item result for the provided OData request.

Type Parameters:

T - The generic entity type.

Parameters:

operation - The OData operation that was used in the OData batch request.

Returns:

The list of entities as result of the request.

Throws:

ODataResponseException - When the OData batch response cannot be parsed.

IllegalArgumentException - When the provided request reference could not be found in the original batch request.

getReadResult

@Nonnull
public <T> List<T> getReadResult(@Nonnull
                                          CollectionValueFunctionRequestBuilder<T> operation)

Extract the batch item result for the provided OData request.

Type Parameters:

T - The generic object type.

Parameters:

operation - The OData operation that was used in the OData batch request.

Returns:

The list of objects as result of the request.

Throws:

ODataResponseException - When the OData batch response cannot be parsed.

IllegalArgumentException - When the provided request reference could not be found in the original batch request.

getReadResult

@Nonnull
public <T extends VdmEntity<?>> T getReadResult(@Nonnull
                                                         GetByKeyRequestBuilder<T> operation)

Extract the batch item result for the provided OData request.

Type Parameters:

T - The generic entity type.

Parameters:

operation - The OData operation that was used in the OData batch request.

Returns:

The list of entities as result of the request.

Throws:

ODataResponseException - When the OData batch response cannot be parsed.

IllegalArgumentException - When the provided request reference could not be found in the original batch request.

getReadResult

@Nonnull
public <T> T getReadResult(@Nonnull
                                    SingleValueFunctionRequestBuilder<T> operation)

Extract the batch item result for the provided OData request.

Type Parameters:

T - The generic object type.

Parameters:

operation - The OData operation that was used in the OData batch request.

Returns:

The object as result of the request.

Throws:

ODataResponseException - When the OData batch response cannot be parsed.

IllegalArgumentException - When the provided request reference could not be found in the original batch request.

getModificationResult

@Nonnull
public <EntityT extends VdmEntity<?>> ModificationResponse<EntityT> getModificationResult(@Nonnull
                                                                                                   CreateRequestBuilder<EntityT> operation)

Extract the batch item result for the provided OData request.

Type Parameters:

EntityT - The generic entity type.

Parameters:

operation - The OData operation that was used in the OData batch request.

Returns:

The generic modification response wrapper object as result of the modification request.

Throws:

ODataResponseException - When the OData batch response cannot be parsed.

IllegalArgumentException - When the provided request reference could not be found in the original batch request.

getModificationResult

@Nonnull
public <EntityT extends VdmEntity<?>> ModificationResponse<EntityT> getModificationResult(@Nonnull
                                                                                                   UpdateRequestBuilder<EntityT> operation)

Extract the batch item result for the provided OData request.

Type Parameters:

EntityT - The generic entity type.

Parameters:

operation - The OData operation that was used in the OData batch request.

Returns:

The generic modification response wrapper object as result of the modification request.

Throws:

ODataResponseException - When the OData batch response cannot be parsed.

IllegalArgumentException - When the provided request reference could not be found in the original batch request.

getModificationResult

@Nonnull
public <EntityT extends VdmEntity<?>> ModificationResponse<EntityT> getModificationResult(@Nonnull
                                                                                                   DeleteRequestBuilder<EntityT> operation)

Extract the batch item result for the provided OData request.

Type Parameters:

EntityT - The generic entity type.

Parameters:

operation - The OData operation that was used in the OData batch request.

Returns:

The generic modification response wrapper object as result of the modification request.

Throws:

ODataResponseException - When the OData batch response cannot be parsed.

IllegalArgumentException - When the provided request reference could not be found in the original batch request.

getModificationResult

@Nonnull
public <T> ActionResponseSingle<T> getModificationResult(@Nonnull
                                                                  SingleValueActionRequestBuilder<T> operation)

Extract the batch item result for the provided OData request.

Type Parameters:

T - The generic object type.

Parameters:

operation - The OData operation that was used in the OData batch request.

Returns:

The generic action response wrapper object as result of the OData action request.

Throws:

ODataResponseException - When the OData batch response cannot be parsed.

IllegalArgumentException - When the provided request reference could not be found in the original batch request.

getModificationResult

@Nonnull
public <T> ActionResponseCollection<T> getModificationResult(@Nonnull
                                                                      CollectionValueActionRequestBuilder<T> operation)

Extract the batch item result for the provided OData request.

Type Parameters:

T - The generic object type.

Parameters:

operation - The OData operation that was used in the OData batch request.

Returns:

The generic action response wrapper object as result of the OData action request.

Throws:

ODataResponseException - When the OData batch response cannot be parsed.

IllegalArgumentException - When the provided request reference could not be found in the original batch request.

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object