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

Class HeaderReleaseFluentHelper

java.lang.Object

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

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperFunction<HeaderReleaseFluentHelper,ActionResponse,ActionResponse>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.HeaderReleaseFluentHelper

All Implemented Interfaces:

FluentHelperCustomHttpHeader<HeaderReleaseFluentHelper>, FluentHelperExecutable<Object>

public class HeaderReleaseFluentHelper
extends FluentHelperFunction<HeaderReleaseFluentHelper,ActionResponse,ActionResponse>

Fluent helper for the HeaderRelease OData function import.

Constructor Summary

Constructors

Constructor and Description

HeaderReleaseFluentHelper(String servicePath, String schedulingAgreement, Boolean schedgAgreementWithJitProfile, Boolean schedgAgreementWithFrcProfile, Boolean schedgAgreementCreateFrcAndJit, Boolean schedgAgreementCreateFrcOnly, Boolean schedgAgreementCreateJitOnly, Boolean schedgAgreementCreateWoutSline, Boolean schedgAgreementDeactFrcTolChck, Boolean schedgAgreementdeactJitTolChck, String schedgAgreementMoveCreateDate, Boolean schedgAgreementOffFrcDynStop, Boolean schedgAgreementOffJitDynStop, String schedgAgreementSelectionScope, String schedgAgreementStandardRelDate) Creates a fluent helper object that will execute the HeaderRelease 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.
ActionResponse	execute(HttpDestinationProperties destination) Deprecated. Use the improved method executeRequest(HttpDestinationProperties) instead.
protected Class<ActionResponse>	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, executeRequest, executeSingle, getJsonResponseObjectName, toRequest

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

and, cachingMetadata, getHeaders, getHeadersForRequestAndImplicitRequests, getHeadersForRequestOnly, getParametersForRequestOnly, getServicePath, getThis, getVersionIdentifier, isCachingMetadata, onRequestAndImplicitRequests, onRequestOnly, withHeader, withHeaders, withoutCachingMetadata, withQueryParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderReleaseFluentHelper

public HeaderReleaseFluentHelper(@Nonnull
                                 String servicePath,
                                 @Nonnull
                                 String schedulingAgreement,
                                 @Nonnull
                                 Boolean schedgAgreementWithJitProfile,
                                 @Nonnull
                                 Boolean schedgAgreementWithFrcProfile,
                                 @Nonnull
                                 Boolean schedgAgreementCreateFrcAndJit,
                                 @Nonnull
                                 Boolean schedgAgreementCreateFrcOnly,
                                 @Nonnull
                                 Boolean schedgAgreementCreateJitOnly,
                                 @Nonnull
                                 Boolean schedgAgreementCreateWoutSline,
                                 @Nonnull
                                 Boolean schedgAgreementDeactFrcTolChck,
                                 @Nonnull
                                 Boolean schedgAgreementdeactJitTolChck,
                                 @Nonnull
                                 String schedgAgreementMoveCreateDate,
                                 @Nonnull
                                 Boolean schedgAgreementOffFrcDynStop,
                                 @Nonnull
                                 Boolean schedgAgreementOffJitDynStop,
                                 @Nonnull
                                 String schedgAgreementSelectionScope,
                                 @Nonnull
                                 String schedgAgreementStandardRelDate)

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

Parameters:

schedgAgreementWithJitProfile - Scheduling Agreement Jit Release Strategy Profile

Constraints: none

Original parameter name from the Odata EDM: SchedgAgreementWithJitProfile

schedgAgreementCreateWoutSline - Create without Schedule Line

Constraints: none

Original parameter name from the Odata EDM: SchedgAgreementCreateWoutSline

schedgAgreementCreateFrcOnly - Forecast Only

Constraints: none

Original parameter name from the Odata EDM: SchedgAgreementCreateFrcOnly

schedgAgreementdeactJitTolChck - Deactivate Jit Tolerance Check

Constraints: none

Original parameter name from the Odata EDM: SchedgAgreementdeactJitTolChck

schedgAgreementStandardRelDate - Schediling Agreement Release Date

Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: SchedgAgreementStandardRelDate

schedgAgreementMoveCreateDate - Move Release Creation Date

Constraints: Not nullable, Maximum length: 2

Original parameter name from the Odata EDM: SchedgAgreementMoveCreateDate

schedgAgreementSelectionScope - Scope of Selection

Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: SchedgAgreementSelectionScope

schedgAgreementCreateFrcAndJit - Forecast And Jit Schedule

Constraints: none

Original parameter name from the Odata EDM: SchedgAgreementCreateFrcAndJit

schedgAgreementOffFrcDynStop - Deactivate Forecast Dynamic Stopping

Constraints: none

Original parameter name from the Odata EDM: SchedgAgreementOffFrcDynStop

schedulingAgreement - Scheduling Agreement

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: SchedulingAgreement

schedgAgreementOffJitDynStop - Deactivate Jit Dynamic Stopping

Constraints: none

Original parameter name from the Odata EDM: SchedgAgreementOffJitDynStop

schedgAgreementWithFrcProfile - Scheduling Agreement Forecast Release Strategy Profile

Constraints: none

Original parameter name from the Odata EDM: SchedgAgreementWithFrcProfile

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

schedgAgreementDeactFrcTolChck - Deactivate Forecast Tolearance Check

Constraints: none

Original parameter name from the Odata EDM: SchedgAgreementDeactFrcTolChck

schedgAgreementCreateJitOnly - Jit Only

Constraints: none

Original parameter name from the Odata EDM: SchedgAgreementCreateJitOnly

Method Detail

getEntityClass

@Nonnull
protected Class<ActionResponse> getEntityClass()

Description copied from class: FluentHelperBasic

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

Specified by:

getEntityClass in class FluentHelperBasic<HeaderReleaseFluentHelper,ActionResponse,ActionResponse>

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<HeaderReleaseFluentHelper,ActionResponse,ActionResponse>

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<HeaderReleaseFluentHelper,ActionResponse,ActionResponse>

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<HeaderReleaseFluentHelper,ActionResponse,ActionResponse>

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<HeaderReleaseFluentHelper,ActionResponse,ActionResponse>

Parameters:

uri - The URI the request should target.

Returns:

The instantiated request.

execute

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

Deprecated. Use the improved method executeRequest(HttpDestinationProperties) instead.

Execute this function import.

Specified by:

execute in class FluentHelperBasic<HeaderReleaseFluentHelper,ActionResponse,ActionResponse>

Parameters:

destination - The destination to use for the request.

Returns:

The result of the executed request

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException - The exception occurred during request execution