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

Class SingleValueFunctionRequestBuilder<ResultT>

java.lang.Object

com.sap.cloud.sdk.datamodel.odatav4.core.FunctionRequestBuilder<SingleValueFunctionRequestBuilder<ResultT>,ResultT>

com.sap.cloud.sdk.datamodel.odatav4.core.SingleValueFunctionRequestBuilder<ResultT>

Type Parameters:

ResultT - The type of the result entity, if any.

All Implemented Interfaces:

ReadOperation

public class SingleValueFunctionRequestBuilder<ResultT>
extends FunctionRequestBuilder<SingleValueFunctionRequestBuilder<ResultT>,ResultT>

Representation of an OData function request as a fluent interface for further configuring the request and executing it. This one handles functions where the return type is a single primitive or entity value.

Constructor Summary

Constructors

Constructor and Description
SingleValueFunctionRequestBuilder(String servicePath, String functionName, Class<ResultT> resultClass) Instantiates this fluent helper using the given service path to send the requests.
SingleValueFunctionRequestBuilder(String servicePath, String functionName, Map<String,Object> parameters, Class<ResultT> resultClass) Instantiates this fluent helper using the given service path to send the requests.

Method Summary

Modifier and Type	Method and Description
ResultT	execute(HttpDestinationProperties destination) Execute the OData request.
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 Class<ResultT>	getResultClass()
protected String	getServicePath()
protected FluentHelperT	getThis() Get the reference to this instance.
io.vavr.control.Try<ResultT>	tryExecute(HttpDestinationProperties destination) Safely execute the OData request.
FluentHelperT	withHeader(String key, String value) Gives the option to specify custom HTTP headers.
FluentHelperT	withHeaders(Map<String,String> map) Gives the option to specify a map of custom HTTP headers.
FluentHelperT	withListener(ODataRequestListener listener) An error handling class that implements the error result handler interface can be attached to this fluent helper.
FluentHelperT	withQueryParameter(String key, String value) Gives the option to specify custom query parameters for the request.

Methods inherited from class com.sap.cloud.sdk.datamodel.odatav4.core.FunctionRequestBuilder

addFunctionParameter, getFunctionName, toRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleValueFunctionRequestBuilder

public SingleValueFunctionRequestBuilder(@Nonnull
                                         String servicePath,
                                         @Nonnull
                                         String functionName,
                                         @Nonnull
                                         Class<ResultT> resultClass)

Instantiates this fluent helper using the given service path to send the requests.

Parameters:

servicePath - The service path to direct the requests to.

functionName - The name of the unbound function

resultClass - The expected return type of the function.

SingleValueFunctionRequestBuilder

public SingleValueFunctionRequestBuilder(@Nonnull
                                         String servicePath,
                                         @Nonnull
                                         String functionName,
                                         @Nonnull
                                         Map<String,Object> parameters,
                                         @Nonnull
                                         Class<ResultT> resultClass)

Instantiates this fluent helper using the given service path to send the requests.

Parameters:

servicePath - The service path to direct the requests to.

functionName - The name of the unbound function

parameters - The parameters passed to the function.

resultClass - The expected collection return type of the function.

Method Detail

execute

@Nonnull
public ResultT execute(@Nonnull
                                HttpDestinationProperties destination)

Execute the OData request.

Parameters:

destination - The destination to be used as request target.

Returns:

The generic OData response result.

getResultClass

protected Class<ResultT> getResultClass()

getThis

@Nonnull
protected FluentHelperT getThis()

Get the reference to this instance.

Returns:

The FluentHelper instance.

tryExecute

@Nonnull
public io.vavr.control.Try<ResultT> tryExecute(@Nonnull
                                                        HttpDestinationProperties destination)

Safely execute the OData request.

Parameters:

destination - The destination to be used as request target.

Returns:

The generic OData response result wrapped in a Try block.

withListener

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

An error handling class that implements the error result handler interface can be attached to this fluent helper. 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 fluent helper 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 fluent helper with its error handler set to the provided object.

withHeader

@Nonnull
 @Beta
public FluentHelperT withHeader(@Nonnull
                                                String key,
                                                @Nullable
                                                String value)

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

Parameters:

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

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

Returns:

A fluent helper to specify further headers and their intended usage.

withHeaders

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

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.

Parameters:

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

Returns:

A fluent helper to specify further headers and their intended usage.

withQueryParameter

@Nonnull
 @Beta
public FluentHelperT 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 fluent helper 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 fluent helper.

getServicePath

@Nonnull
protected String getServicePath()

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