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

Class SchedulePlannedOrderOperationFluentHelper

java.lang.Object

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

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperFunction<SchedulePlannedOrderOperationFluentHelper,SchedldProdOrdOpMessage,SchedldProdOrdOpMessage>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.plannedorder.SchedulePlannedOrderOperationFluentHelper

All Implemented Interfaces:

FluentHelperCustomHttpHeader<SchedulePlannedOrderOperationFluentHelper>, FluentHelperExecutable<Object>

public class SchedulePlannedOrderOperationFluentHelper
extends FluentHelperFunction<SchedulePlannedOrderOperationFluentHelper,SchedldProdOrdOpMessage,SchedldProdOrdOpMessage>

Fluent helper for the SchedulePlannedOrderOperation OData function import.

Constructor Summary

Constructors

Constructor and Description

SchedulePlannedOrderOperationFluentHelper(String servicePath, String plannedOrder, String capacityRequirement, String capacityRequirementItem, String capacityRqmtItemCapacity, LocalDateTime opSchedldStartDate, LocalTime opSchedldStartTime, LocalDateTime opSchedldEndDate, LocalTime opSchedldEndTime, String opSchedulingMode, String opSchedulingStatus, String opSchedulingStrategy) Creates a fluent helper object that will execute the SchedulePlannedOrderOperation 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.
SchedldProdOrdOpMessage	execute(HttpDestinationProperties destination) Deprecated. Use the improved method executeRequest(HttpDestinationProperties) instead.
protected Class<SchedldProdOrdOpMessage>	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

SchedulePlannedOrderOperationFluentHelper

public SchedulePlannedOrderOperationFluentHelper(@Nonnull
                                                 String servicePath,
                                                 @Nonnull
                                                 String plannedOrder,
                                                 @Nonnull
                                                 String capacityRequirement,
                                                 @Nonnull
                                                 String capacityRequirementItem,
                                                 @Nonnull
                                                 String capacityRqmtItemCapacity,
                                                 @Nullable
                                                 LocalDateTime opSchedldStartDate,
                                                 @Nullable
                                                 LocalTime opSchedldStartTime,
                                                 @Nullable
                                                 LocalDateTime opSchedldEndDate,
                                                 @Nullable
                                                 LocalTime opSchedldEndTime,
                                                 @Nonnull
                                                 String opSchedulingMode,
                                                 @Nullable
                                                 String opSchedulingStatus,
                                                 @Nonnull
                                                 String opSchedulingStrategy)

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

Parameters:

capacityRequirementItem - Counter

Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: CapacityRequirementItem

opSchedldStartDate - Latest Start Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: OpSchedldStartDate

capacityRequirement - Capacity Requirement

Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: CapacityRequirement

plannedOrder - Planned Order

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: PlannedOrder

capacityRqmtItemCapacity - Counter

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: CapacityRqmtItemCapacity

opSchedulingStrategy - Component of the Version Number

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: OpSchedulingStrategy

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

opSchedulingStatus - Status

Constraints: Nullable, Maximum length: 4

Original parameter name from the Odata EDM: OpSchedulingStatus

opSchedulingMode - Scheduling type

Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: OpSchedulingMode

opSchedldStartTime - Latest Start Time

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: OpSchedldStartTime

opSchedldEndDate - Latest End Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: OpSchedldEndDate

opSchedldEndTime - Latest End Time

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: OpSchedldEndTime

Method Detail

getEntityClass

@Nonnull
protected Class<SchedldProdOrdOpMessage> getEntityClass()

Description copied from class: FluentHelperBasic

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

Specified by:

getEntityClass in class FluentHelperBasic<SchedulePlannedOrderOperationFluentHelper,SchedldProdOrdOpMessage,SchedldProdOrdOpMessage>

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<SchedulePlannedOrderOperationFluentHelper,SchedldProdOrdOpMessage,SchedldProdOrdOpMessage>

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<SchedulePlannedOrderOperationFluentHelper,SchedldProdOrdOpMessage,SchedldProdOrdOpMessage>

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<SchedulePlannedOrderOperationFluentHelper,SchedldProdOrdOpMessage,SchedldProdOrdOpMessage>

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<SchedulePlannedOrderOperationFluentHelper,SchedldProdOrdOpMessage,SchedldProdOrdOpMessage>

Parameters:

uri - The URI the request should target.

Returns:

The instantiated request.

execute

@Deprecated
 @Nullable
public SchedldProdOrdOpMessage 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<SchedulePlannedOrderOperationFluentHelper,SchedldProdOrdOpMessage,SchedldProdOrdOpMessage>

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