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

Class GetByKeyRequestBuilder<EntityT extends VdmEntity<?>>

java.lang.Object

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

Type Parameters:

EntityT - The type of the result entity.

All Implemented Interfaces:

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

public class GetByKeyRequestBuilder<EntityT extends VdmEntity<?>>
extends Object
implements ReadRequestBuilder<EntityT>

Representation of an OData request to retrieve an entity by its key as a fluent interface for further configuring the request and executing it.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
EntityT	execute(HttpDestinationProperties destination) Execute the OData request.
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.
protected ODataResourcePath	getResourcePath()
protected String	getServicePath()
protected BuilderT	getThis() Get the reference to this instance.
GetByKeyRequestBuilder<EntityT>	select(Property<EntityT>... fields) Query modifier to limit which field values of the entity EntityT get fetched and populated.
ODataRequestReadByKey	toRequest() Creates an instance of ODataRequestReadByKey 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.
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

GetByKeyRequestBuilder

public GetByKeyRequestBuilder(@Nonnull
                              String servicePath,
                              @Nonnull
                              Class<EntityT> entityClass,
                              @Nonnull
                              Map<String,Object> key)

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.

key - The composite entity key.

Throws:

IllegalArgumentException - When there is no mapping found for one of the provided Java literal in the composite key.

GetByKeyRequestBuilder

public GetByKeyRequestBuilder(@Nonnull
                              String servicePath,
                              @Nonnull
                              Class<EntityT> entityClass,
                              @Nonnull
                              Map<String,Object> entityKey,
                              @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.

entityKey - The composite entity key.

entityCollection - The entity collection

Throws:

IllegalArgumentException - When there is no mapping found for one of the provided Java literal in the composite key.

Method Detail

toRequest

@Nonnull
 @Beta
public ODataRequestReadByKey toRequest()

Creates an instance of ODataRequestReadByKey based on the Entity class.

The following settings are used:

• the endpoint URL
• the entity collection name
• the key fields of the entity
• the fields to be selected

Specified by:

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

Returns:

An initialized ODataRequestReadByKey.

execute

@Nonnull
 @Beta
public EntityT execute(@Nonnull
                                       HttpDestinationProperties destination)

Execute the OData request.

Specified by:

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

Parameters:

destination - The destination to be used as request target.

Returns:

The generic OData response result.

select

@SafeVarargs
 @Nonnull
public final GetByKeyRequestBuilder<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.

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()