com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks

Class ReleaseCreditBlockFluentHelper

java.lang.Object

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

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperFunction<ReleaseCreditBlockFluentHelper,ReturnMessage,ReturnMessage>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdocumentwithcreditblocks.ReleaseCreditBlockFluentHelper

public class ReleaseCreditBlockFluentHelper
extends FluentHelperFunction<ReleaseCreditBlockFluentHelper,ReturnMessage,ReturnMessage>

Fluent helper for the ReleaseCreditBlock OData function import.

Constructor Summary

Constructors

Constructor and Description
ReleaseCreditBlockFluentHelper(String servicePath, String sDDocumentCategory, String salesDocument) Creates a fluent helper object that will execute the ReleaseCreditBlock OData function import with the provided parameters.

Method Summary

Modifier and Type	Method and Description
protected org.apache.http.client.methods.HttpUriRequest	createRequest(URI uri) Creates a request for this function based on the given URI.
ReturnMessage	execute(HttpDestinationProperties destination)
protected Class<ReturnMessage>	getEntityClass() Returns a class object of the type this fluent helper works with.
protected String	getFunctionName() The exact name of the function to be called on the OData Endpoint.
protected Map<String,Object>	getParameters() Getter for the map of parameters to be used in the function call.
protected com.google.gson.JsonElement	refineJsonResponse(com.google.gson.JsonElement jsonElement) Transform the JSON element from the response to extract a result entity.

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperFunction

executeMultiple, executeSingle, getJsonResponseObjectName

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperBasic

cachingMetadata, getHeadersForRequestAndImplicitRequests, getHeadersForRequestOnly, getParametersForRequestOnly, getServicePath, getThis, getVersionIdentifier, isCachingMetadata, withHeader, withHeaders, withoutCachingMetadata, withQueryParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

ReleaseCreditBlockFluentHelper

public ReleaseCreditBlockFluentHelper(@Nonnull
                                      String servicePath,
                                      String sDDocumentCategory,
                                      String salesDocument)

Creates a fluent helper object that will execute the ReleaseCreditBlock OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

Parameters:

salesDocument - Constraints: none

Original parameter name from the Odata EDM: SalesDocument

sDDocumentCategory - Constraints: none

Original parameter name from the Odata EDM: SDDocumentCategory

servicePath - Service path to be used to call the functions against.

Method Detail

getEntityClass

@Nonnull
protected Class<ReturnMessage> getEntityClass()

Description copied from class: FluentHelperBasic

Returns a class object of the type this fluent helper works with.

Specified by:

getEntityClass in class FluentHelperBasic<ReleaseCreditBlockFluentHelper,ReturnMessage,ReturnMessage>

Returns:

A class object of the handled type.

getFunctionName

@Nonnull
protected String getFunctionName()

Description copied from class: FluentHelperFunction

The exact name of the function to be called on the OData Endpoint.

Specified by:

getFunctionName in class FluentHelperFunction<ReleaseCreditBlockFluentHelper,ReturnMessage,ReturnMessage>

Returns:

The function name on the endpoint.

refineJsonResponse

@Nullable
protected com.google.gson.JsonElement refineJsonResponse(@Nullable
                                                                   com.google.gson.JsonElement jsonElement)

Description copied from class: FluentHelperFunction

Transform the JSON element from the response to extract a result entity. By default this method returns the original object.

Overrides:

refineJsonResponse in class FluentHelperFunction<ReleaseCreditBlockFluentHelper,ReturnMessage,ReturnMessage>

Parameters:

jsonElement - The optional response JSON element

Returns:

The refined JSON element

getParameters

@Nonnull
protected Map<String,Object> getParameters()

Description copied from class: FluentHelperFunction

Getter for the map of parameters to be used in the function call.

The map maps the ODataName of a parameter to the corresponding value.

Specified by:

getParameters in class FluentHelperFunction<ReleaseCreditBlockFluentHelper,ReturnMessage,ReturnMessage>

Returns:

A map containing the parameter for the function call.

createRequest

@Nonnull
protected org.apache.http.client.methods.HttpUriRequest createRequest(@Nonnull
                                                                               URI uri)

Description copied from class: FluentHelperFunction

Creates a request for this function based on the given URI.

Examples for such requests are HttpGet and HttpPost.

Specified by:

createRequest in class FluentHelperFunction<ReleaseCreditBlockFluentHelper,ReturnMessage,ReturnMessage>

Parameters:

uri - The URI the request should target.

Returns:

The instantiated request.

execute

@Nullable
public ReturnMessage execute(@Nonnull
                                       HttpDestinationProperties destination)
                                throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Specified by:

execute in class FluentHelperBasic<ReleaseCreditBlockFluentHelper,ReturnMessage,ReturnMessage>

Throws:

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