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

Class ODataRequestResultMultipartGeneric

java.lang.Object

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

All Implemented Interfaces:

ODataRequestResult, ODataRequestResultMultipart, AutoCloseable

public class ODataRequestResultMultipartGeneric
extends Object
implements ODataRequestResultMultipart, ODataRequestResult, AutoCloseable

OData request result for reading entities.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the underlying HTTP response entity.
List<List<org.apache.http.HttpResponse>>	getBatchedResponses()	Get the multi-part segments as raw HTTP response object.
org.apache.http.HttpResponse	getHttpResponse()	Get the original OData HttpResponse instance, which holds the HttpEntity and header information.
ODataRequestBatch	getODataRequest()	Get the original batch request that was used for running the OData request.
ODataRequestResultGeneric	getResult(ODataRequestGeneric request)	Gets the ODataRequestResultGeneric for the given request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestResult

getAllHeaderValues, getHeaderNames, getHeaderValues

Method Details

getODataRequest

@Nonnull
public ODataRequestBatch getODataRequest()

Get the original batch request that was used for running the OData request.

Specified by:

getODataRequest in interface ODataRequestResult

Returns:

The batch request this

getResult

@Nonnull
public ODataRequestResultGeneric getResult(@Nonnull
 ODataRequestGeneric request)
                                    throws ODataResponseException,
IllegalArgumentException

Gets the ODataRequestResultGeneric for the given request.

Specified by:

getResult in interface ODataRequestResultMultipart

Parameters:

request - The request for which the result should be returned.

Returns:

The result for the given request.

Throws:

ODataResponseException - When the OData batch response cannot be parsed or HTTP response is not healthy.

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

ODataServiceErrorException - When the response contains an OData error message according to specification.

getBatchedResponses

@Nonnull
public List<List<org.apache.http.HttpResponse>> getBatchedResponses()

Get the multi-part segments as raw HTTP response object. Response objects of same changesets are grouped.

Please note: The returned list is lazily evaluated. The underlying HTTP response entity is being parsed, upon list access.

Returns:

The virtual HTTP response objects.

close

@Beta
public void close()

Closes the underlying HTTP response entity.

Specified by:

close in interface AutoCloseable

Since:

5.5.0

getHttpResponse

@Nonnull
public org.apache.http.HttpResponse getHttpResponse()

Description copied from interface: ODataRequestResult

Get the original OData HttpResponse instance, which holds the HttpEntity and header information.

Specified by:

getHttpResponse in interface ODataRequestResult

Returns:

The HttpResponse.