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

Class GetAllRequestBuilder<EntityT extends VdmEntity<?>>

java.lang.Object

com.sap.cloud.sdk.datamodel.odatav4.core.GetAllRequestBuilder<EntityT>

Type Parameters:

EntityT - The type of the result entity.

All Implemented Interfaces:

ReadRequestBuilder<List<EntityT>>, RequestBuilder<List<EntityT>>, RequestBuilderExecutable<List<EntityT>>

public class GetAllRequestBuilder<EntityT extends VdmEntity<?>>
extends Object
implements ReadRequestBuilder<List<EntityT>>

Representation of an OData request as a fluent interface for further configuring the request and executing it.

Constructor Summary

Constructors

Constructor and Description
GetAllRequestBuilder(String servicePath, Class<EntityT> entityClass) Instantiates this request builder using the given service path to send the requests.
GetAllRequestBuilder(String servicePath, Class<EntityT> entityClass, String entityCollection) Instantiates this request builder using the given service path to send the requests.

Method Summary

Modifier and Type	Method and Description
List<EntityT>	execute(HttpDestinationProperties destination) Execute the OData request.
GetAllRequestBuilder<EntityT>	filter(FilterableBoolean<EntityT>... filters) Filter on properties of EntityT.
String	getEncodedQueryString() Return the percentage encoded string representation of the underlying request that is being build by this request builder.
protected Class<EntityT>	getEntityClass() Returns a class object of the type this request builder works with.
protected Map<String,String>	getHeaders() A map containing the headers to be used only for the actual request of this FluentHelper implementation.
protected List<ODataRequestListener>	getListeners()
protected Map<String,String>	getParametersForRequestOnly() A map containing the custom query parameters to be used only for the actual request of this FluentHelper implementation.
String	getQueryString() Return the string representation of the underlying request that is being build by this request builder.
protected ODataResourcePath	getResourcePath()
protected String	getServicePath()
protected BuilderT	getThis() Get the reference to this instance.
RequestBuilderExecutable<Iterable<EntityT>>	iteratingEntities() Iterate through all entities from the result-set.
RequestBuilderExecutable<Iterable<List<EntityT>>>	iteratingPages() Manually explore the individual pages from the result-set.
GetAllRequestBuilder<EntityT>	orderBy(FieldOrdering<EntityT>... ordering) Sort the set of returned entities by non-complex fields.
GetAllRequestBuilder<EntityT>	search(SearchExpression expression) Request modifier to return the set of entities corresponding to the specified boolean expression.
GetAllRequestBuilder<EntityT>	search(String search) Request modifier to return the set of entities that contain the specified value.
GetAllRequestBuilder<EntityT>	select(Property<EntityT>... fields) Query modifier to limit which field values of the entity EntityT get fetched and populated.
GetAllRequestBuilder<EntityT>	skip(int skip) Determine the how many first N entities of the result set should be skipped.
RequestBuilderExecutable<Stream<EntityT>>	streamingEntities() Stream through all entities from the result-set.
GetAllRequestBuilder<EntityT>	top(int top) Limit the number of results of this request.
ODataRequestRead	toRequest() Creates an instance of the ODataRequestRead based on the Entity class.
BuilderT	withHeader(String key, String value) Gives the option to specify custom HTTP headers.
BuilderT	withHeaders(Map<String,String> map) Gives the option to specify a map of custom HTTP headers.
BuilderT	withListener(ODataRequestListener listener) An error handling class that implements the error result handler interface can be attached to this request builder.
GetAllRequestBuilder<EntityT>	withPreferredPageSize(int size) Set the preferred page size of the OData response.
BuilderT	withQueryParameter(String key, String value) Gives the option to specify custom query parameters for the 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.odatav4.core.RequestBuilder

withHeader, withHeaders

Methods inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.RequestBuilderExecutable

tryExecute

Constructor Detail

GetAllRequestBuilder

public GetAllRequestBuilder(@Nonnull
                            String servicePath,
                            @Nonnull
                            Class<EntityT> entityClass)

Instantiates this request builder using the given service path to send the requests.

Parameters:

servicePath - The service path to direct the requests to.

entityClass - The expected entity type.

GetAllRequestBuilder

public GetAllRequestBuilder(@Nonnull
                            String servicePath,
                            @Nonnull
                            Class<EntityT> entityClass,
                            @Nonnull
                            String entityCollection)

Instantiates this request builder using the given service path to send the requests.

Parameters:

servicePath - The service path to direct the requests to.

entityClass - The expected entity type.

entityCollection - The entity collection

Method Detail

toRequest

@Nonnull
 @Beta
public ODataRequestRead toRequest()

Creates an instance of the ODataRequestRead based on the Entity class.

The following settings are used:

• the endpoint URL
• the entity collection name
• the number of entries to select (top)
• the number of entries to ignore (skip)
• the order direction
• the filters to be applied
• the fields to be selected

Specified by:

toRequest in interface RequestBuilder<List<EntityT extends VdmEntity<?>>>

Returns:

An initialized ODataRequestRead.

getEncodedQueryString

@Beta
 @Nonnull
public String getEncodedQueryString()

Return the percentage encoded string representation of the underlying request that is being build by this request builder. This includes all query parameters as well as nested queries but not the entity, the service path or other request options like format.

Returns:

The underlying request as query string.

getQueryString

@Beta
 @Nonnull
public String getQueryString()

Return the string representation of the underlying request that is being build by this request builder. This includes all query parameters as well as nested queries but not the entity, the service path or other request options like format.

Returns:

The underlying request as query string.

execute

@Nonnull
public List<EntityT> execute(@Nonnull
                                      HttpDestinationProperties destination)

Execute the OData request.

Note: If the OData service responds with service-driven pagination, then the pages will be iterated automatically. The returned list is an eagerly loaded aggregation of all pages. Access to a lazy loading result-set can be enabled through the modifiers iteratingEntities(), streamingEntities() and iteratingPages().

Specified by:

execute in interface RequestBuilderExecutable<List<EntityT extends VdmEntity<?>>>

Parameters:

destination - The destination to be used as request target.

Returns:

The generic OData response result.

iteratingPages

@Beta
 @Nonnull
public RequestBuilderExecutable<Iterable<List<EntityT>>> iteratingPages()

Manually explore the individual pages from the result-set. The returning object allows for memory-efficient consumption of all data through server-driven pagination.

Returns:

An instance of RequestBuilderExecutable with a response object to lazily iterate through the pages of entities.

iteratingEntities

@Beta
 @Nonnull
public RequestBuilderExecutable<Iterable<EntityT>> iteratingEntities()

Iterate through all entities from the result-set. The individual pages of the result-set are queried lazily. The returning object allows for memory-efficient consumption of all data through server-driven pagination.

Returns:

An instance of RequestBuilderExecutable with a response object to lazily iterate through the entities.

streamingEntities

@Beta
 @Nonnull
public RequestBuilderExecutable<Stream<EntityT>> streamingEntities()

Stream through all entities from the result-set. The individual pages of the result-set are queried lazily. The returning object allows for memory-efficient consumption of all data through server-driven pagination.

Returns:

An instance of RequestBuilderExecutable with a response object to lazily iterate through the entities.

withPreferredPageSize

@Nonnull
 @Beta
public GetAllRequestBuilder<EntityT> withPreferredPageSize(int size)

Set the preferred page size of the OData response. A result-set may be split into multiple pages, each including a subset of the entities matching the query.

Note: The OData service might ignore the preferred page size setting and may not use pagination at all.

Parameters:

size - The preferred page size

Returns:

This request object with the added parameter.

select

@SafeVarargs
 @Nonnull
public final GetAllRequestBuilder<EntityT> select(@Nonnull
                                                                         Property<EntityT>... fields)

Query modifier to limit which field values of the entity EntityT get fetched and populated. Navigational properties supplied here will be expanded. If this method is called at least once, then only the specified fields will be fetched and populated. If none of the select methods is called, then all fields will be fetched and populated. Calling this multiple times will combine the set(s) of fields of each call.

Parameters:

fields - Properties of EntityT to be selected.

Returns:

This request object with the added selections.

filter

@SafeVarargs
 @Nonnull
public final GetAllRequestBuilder<EntityT> filter(@Nonnull
                                                                         FilterableBoolean<EntityT>... filters)

Filter on properties of EntityT.

Parameters:

filters - Filter expressions to be added to the request.

Returns:

This request object with the added filters.

top

@Nonnull
public GetAllRequestBuilder<EntityT> top(int top)

Limit the number of results of this request.

Parameters:

top - The maximum amount of elements this request shall return.

Returns:

This request with the top parameter set.

skip

@Nonnull
public GetAllRequestBuilder<EntityT> skip(int skip)

Determine the how many first N entities of the result set should be skipped. If this method is never called, then the full list will be returned from the first entity. If this method is called multiple times, then only the value of the last call will be used.

Parameters:

skip - The amount of elements this request will skip.

Returns:

This request with the skip parameter set.

orderBy

@SafeVarargs
 @Nonnull
 @Beta
public final GetAllRequestBuilder<EntityT> orderBy(@Nonnull
                                                                                 FieldOrdering<EntityT>... ordering)

Sort the set of returned entities by non-complex fields.

Parameters:

ordering - Fields to sort by.

Returns:

This request with the orderBy parameter set.

search

@Nonnull
public GetAllRequestBuilder<EntityT> search(@Nonnull
                                                     String search)

Request modifier to return the set of entities that contain the specified value. If this method is never called, then all the accessible entities will be returned.

Parameters:

search - A string value as the search criteria.

Returns:

The same request builder with this request modifier applied.

search

@Nonnull
public GetAllRequestBuilder<EntityT> search(@Nonnull
                                                     SearchExpression expression)

Request modifier to return the set of entities corresponding to the specified boolean expression. If this method is never called, then all the accessible entities will be returned.

Parameters:

expression - SearchExpression as the search criteria

Returns:

The same request builder with this request modifier applied.

getEntityClass

@Nonnull
protected Class<EntityT> getEntityClass()

Returns a class object of the type this request builder works with.

Returns:

A class object of the handled type.

getThis

@Nonnull
protected BuilderT getThis()

Get the reference to this instance.

Returns:

The FluentHelper instance.

withListener

@Nonnull
 @Beta
public BuilderT withListener(@Nonnull
                                             ODataRequestListener listener)

An error handling class that implements the error result handler interface can be attached to this request builder. This allows custom logic to be called when an error occurs in the execute method. If this method is not called, then an instance of ODataRequestListener is used. Only one handler can be attached at a time per request builder object, so calling this multiple times will replace the handler.

Parameters:

listener - Instance of an error handler class that implements the error result handler interface.

Returns:

The same request builder with its error handler set to the provided object.

withHeader

@Nonnull
public BuilderT withHeader(@Nonnull
                                    String key,
                                    @Nullable
                                    String value)

Description copied from interface: RequestBuilder

Gives the option to specify custom HTTP headers. The returned object allows to specify the requests the headers should be used in.

Specified by:

withHeader in interface RequestBuilder<ResultT>

Parameters:

key - Name of the (first) desired HTTP header parameter.

value - Value of the (first) desired HTTP header parameter.

Returns:

A request builder to specify further headers and their intended usage.

withHeaders

@Nonnull
public BuilderT withHeaders(@Nonnull
                                     Map<String,String> map)

Description copied from interface: RequestBuilder

Gives the option to specify a map of custom HTTP headers. The returned object allows to specify the requests the headers should be used in.

Specified by:

withHeaders in interface RequestBuilder<ResultT>

Parameters:

map - A map of HTTP header key/value pairs.

Returns:

A request builder to specify further headers and their intended usage.

withQueryParameter

@Nonnull
 @Beta
public BuilderT withQueryParameter(@Nonnull
                                                   String key,
                                                   @Nullable
                                                   String value)

Gives the option to specify custom query parameters for the request.

Note: It is recommended to only use this function for query parameters which are not supported by the VDM by default. Using this function to bypass request builder method calls can lead to unsupported response handling. There is no contract on the order or priority of parameters added to the request.

Example: Use the request query option $search to reduce the result set, leaving only entities which match the specified search expression. This feature is supported in protocol OData v4.

 new DefaultBusinessPartnerService().getAllBusinessPartner().withQueryParameter("$search", "Köln OR Cologne")
 

Parameters:

key - Name of the query parameter.

value - Value of the query parameter.

Returns:

The same request builder.

getServicePath

@Nonnull
protected String getServicePath()

getResourcePath

@Nonnull
protected ODataResourcePath getResourcePath()

getHeaders

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

A map containing the headers to be used only for the actual request of this FluentHelper implementation.

getParametersForRequestOnly

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

A map containing the custom query parameters to be used only for the actual request of this FluentHelper implementation.

getListeners

@Nonnull
protected List<ODataRequestListener> getListeners()