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

Interface ODataRequestResult

All Known Implementing Classes:

ODataRequestResultGeneric

@Beta
public interface ODataRequestResult

Generic type of an OData request result.

Method Summary

Modifier and Type	Method and Description
<T> T	as(Class<T> objectType) Converts ODataRequestResult into POJO
<T> List<T>	asList(Class<T> objectType) Converts ODataRequestResult into list of POJOs
List<Map<String,Object>>	asListOfMaps() Construct and get a list of key-value maps from the OData response.
Map<String,Object>	asMap() Construct and get a key-value map from the OData response.
Iterable<String>	getHeaderNames() Get the iterable list of HTTP response header names.
Iterable<String>	getHeaderValues(String headerName) Get the iterable HTTP header values for a specific header name.
org.apache.http.HttpResponse	getHttpResponse() Get the original OData HttpResponse instance, which holds the HttpEntity and header information.
long	getInlineCount() Get the count of elements in the result set.
ODataRequestExecutable	getODataRequest() Get the original ODataRequestExecutable instance that was used for running the OData request.
void	streamElements(Consumer<ResultElement> handler) Run a consumer for fluent API type ResultElement to iterate over the OData response with a continuous data stream.

Method Detail

getODataRequest

@Nonnull
ODataRequestExecutable getODataRequest()

Get the original ODataRequestExecutable instance that was used for running the OData request.

Returns:

The original ODataRequestExecutable instance.

getHttpResponse

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

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

Returns:

The HttpResponse.

as

@Nonnull
<T> T as(@Nonnull
                  Class<T> objectType)

Converts ODataRequestResult into POJO

Type Parameters:

T - The generic type of POJO

Parameters:

objectType - type of POJO

Returns:

T - POJO

asList

@Nonnull
<T> List<T> asList(@Nonnull
                            Class<T> objectType)

Converts ODataRequestResult into list of POJOs

Type Parameters:

T - Generic type of the POJO

Parameters:

objectType - type of POJO

Returns:

List - list of POJOs

streamElements

void streamElements(@Nonnull
                    Consumer<ResultElement> handler)

Run a consumer for fluent API type ResultElement to iterate over the OData response with a continuous data stream. The HttpEntity will be consumed.

Parameters:

handler - The consumer for generic ResultElement.

Throws:

ODataDeserializationException - When deserialization process failed for the OData response object.

getInlineCount

long getInlineCount()

Get the count of elements in the result set.

Returns:

The number of elements.

asMap

@Nonnull
Map<String,Object> asMap()

Construct and get a key-value map from the OData response. The HttpEntity will be consumed.

Returns:

The key-value map.

Throws:

ODataDeserializationException - When deserialization process failed for the OData response object.

asListOfMaps

@Nonnull
List<Map<String,Object>> asListOfMaps()

Construct and get a list of key-value maps from the OData response. The HttpEntity will be consumed.

Returns:

The list of key-value maps.

Throws:

ODataDeserializationException - When deserialization process failed for the OData response object.

getHeaderNames

@Nonnull
Iterable<String> getHeaderNames()

Get the iterable list of HTTP response header names.

Returns:

An iterable set of header names.

getHeaderValues

@Nonnull
Iterable<String> getHeaderValues(@Nonnull
                                          String headerName)

Get the iterable HTTP header values for a specific header name.

Parameters:

headerName - The header name to look for.

Returns:

An iterable set of header values.