com.sap.cloud.sdk.s4hana.datamodel.odata.helper

Class FluentHelperBasic<FluentHelperT,EntityT,ResultT>

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.FluentHelperBasic<FluentHelperT,EntityT,ResultT>

Direct Known Subclasses:

FluentHelperByKey, FluentHelperCreate, FluentHelperDelete, FluentHelperFunction, FluentHelperRead, FluentHelperUpdate

public abstract class FluentHelperBasic<FluentHelperT,EntityT,ResultT>
extends Object

Constructor Summary

Constructors

Constructor and Description
FluentHelperBasic()

Method Summary

Modifier and Type	Method and Description
ResultT	execute() Executes the underlying query using the stored values, plus any query modifiers that were previously called.
abstract ResultT	execute(ErpConfigContext configContext) Executes the underlying query using the stored values, plus any query modifiers that were previously called.
protected abstract Class<? extends EntityT>	getEntityClass()
protected Map<String,String>	getHeadersForRequestAndImplicitRequests() A map containing the header to be used for all implicit requests that are part of this FluentHelper implementation (metadata, csrf, ...).
protected Map<String,String>	getHeadersForRequestOnly() A map containing the header to be used only for the actual request of this FluentHelper implementation.
protected FluentHelperT	getThis()
protected String	getVersionIdentifier(com.sap.cloud.sdk.odatav2.connectivity.internal.ODataHttpResponseWrapper response)
FluentHelperCustomHttpHeader<FluentHelperT>	withCustomHttpHeader(String key, String value) Gives the option to specify custom HTTP headers.
FluentHelperCustomHttpHeader<FluentHelperT>	withCustomHttpHeaders(Map<String,String> map) Gives the option to specify a map of custom HTTP headers.
FluentHelperT	withHttpHeader(String key, String value) Deprecated. Use withCustomHttpHeader(key, value).onRequestAndImplicitRequests() instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

FluentHelperBasic

public FluentHelperBasic()

Method Detail

getEntityClass

protected abstract Class<? extends EntityT> getEntityClass()

getThis

protected FluentHelperT getThis()

execute

public abstract ResultT execute(ErpConfigContext configContext)
                         throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Executes the underlying query using the stored values, plus any query modifiers that were previously called.

Parameters:

configContext - Supply the ERP system context for executing the underlying OData query.

Returns:

A single entity if the query execution is successful. If the underlying OData request fails, then an ODataException is thrown, and the error handler class attached to this fluent helper will be called.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException

See Also:

ErpConfigContext.ErpConfigContext()

execute

public ResultT execute()
                throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Executes the underlying query using the stored values, plus any query modifiers that were previously called.

The default ERP configuration context will be used.

Returns:

A single result element if the query execution is successful. If the underlying OData request fails, then an ODataException is thrown, and the error handler class attached to this fluent helper will be called.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException

See Also:

ErpConfigContext.ErpConfigContext()

withHttpHeader

@Deprecated
public FluentHelperT withHttpHeader(String key,
                                                String value)

Deprecated. Use withCustomHttpHeader(key, value).onRequestAndImplicitRequests() instead.

Adds a HTTP header parameter (key and value) to all underlying OData requests. This affects both the main request and any other implicit requests (metadata, CSRF token, etc.). If a HTTP header parameter with provided name exists, its value will be overwritten. Otherwise it is added to the list of existing parameters.

Parameters:

key - Name of desired HTTP header parameter.

value - Value of desired HTTP header parameter.

Returns:

The same fluent helper with the HTTP header parameter applied.

withCustomHttpHeader

public FluentHelperCustomHttpHeader<FluentHelperT> withCustomHttpHeader(String key,
                                                                        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.

withCustomHttpHeaders

public FluentHelperCustomHttpHeader<FluentHelperT> withCustomHttpHeaders(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.

getVersionIdentifier

@Nullable
protected String getVersionIdentifier(com.sap.cloud.sdk.odatav2.connectivity.internal.ODataHttpResponseWrapper response)

getHeadersForRequestAndImplicitRequests

protected Map<String,String> getHeadersForRequestAndImplicitRequests()

A map containing the header to be used for all implicit requests that are part of this FluentHelper implementation (metadata, csrf, ...).

getHeadersForRequestOnly

protected Map<String,String> getHeadersForRequestOnly()

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