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

Class FluentHelperFunction<FluentHelperT,ObjectT,ResultT>

java.lang.Object

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

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

Type Parameters:

FluentHelperT - The fluent helper type.

ObjectT - The type of the object this OData request operates on, if any.

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

All Implemented Interfaces:

FluentHelperCustomHttpHeader<FluentHelperT>, FluentHelperExecutable<Object>

Direct Known Subclasses:

AcceptFluentHelper, AddEventDrivenKanbanContainerFluentHelper, AddEventDrivenKanbanContainerFluentHelper, AddSerialNumberToDeliveryItemFluentHelper, AddSerialNumberToDeliveryItemFluentHelper, AdjustDeliveryItemQuantityFluentHelper, AdjustDeliveryItemQuantityFluentHelper, AdoptFluentHelper, AdoptFluentHelper, AssignAltDateToDocInfoRecdObjectMgmtRecFluentHelper, AssignAltDateToDocInfoRecdObjectMgmtRecFluentHelper, AssignAltDateToMaterialObjectMgmtRecFluentHelper, AssignAltDateToMaterialObjectMgmtRecFluentHelper, AssignAltDateToMatlBOMObjectMgmtRecFluentHelper, AssignAltDateToMatlBOMObjectMgmtRecFluentHelper, AssignAlternativeDateToObjectMgmtRecordFluentHelper, AssignAlternativeDateToObjectMgmtRecordFluentHelper, AssignLegalTransactionFluentHelper, AssignWarehouseOrderFluentHelper, BOMComparisonFluentHelper, BOMComparisonFluentHelper, CalculateAvailabilityTimeseriesFluentHelper, CalculateAvailabilityTimeseriesFluentHelper, CallActionFluentHelper, CancelFluentHelper, CancelFluentHelper, CancelFluentHelper, CancelFluentHelper, CancelFluentHelper, CancelFluentHelper, CancelFluentHelper, CancelFluentHelper, CancelFluentHelper, CancelFluentHelper, CancelFluentHelper, CancelFluentHelper, CancelItemFluentHelper, CancelItemFluentHelper, CancelMaintOrderConfirmationFluentHelper, CancelProcOrdConfFluentHelper, CancelProcOrdConfFluentHelper, CancelProdnOrdConfFluentHelper, CancelProdnOrdConfFluentHelper, CancelWarehouseTaskFluentHelper, ChangeEntProjElmntPositionFluentHelper, ChangeEntProjElmntProcgStatusFluentHelper, ChangeEntProjProcgStatusFluentHelper, CheckCreditBlockFluentHelper, CheckCreditBlockFluentHelper, CheckCreditBlockFluentHelper, CheckCreditBlockFluentHelper, CloseOrderFluentHelper, CloseOrderFluentHelper, CloseOrderFluentHelper, CloseOrderFluentHelper, CloseOrderFluentHelper, CloseProdnOrdFluentHelper, CompleteFluentHelper, CompleteFluentHelper, CompleteFluentHelper, CompleteFluentHelper, CompleteFluentHelper, CompleteMaintNotificationFluentHelper, CompleteTechnicallyProdnOrdFluentHelper, ConfirmPickingAllItemsFluentHelper, ConfirmPickingAllItemsFluentHelper, ConfirmPickingOneItemFluentHelper, ConfirmPickingOneItemFluentHelper, ConfirmPutawayAllItemsFluentHelper, ConfirmPutawayAllItemsFluentHelper, ConfirmPutawayAllItemsFluentHelper, ConfirmPutawayAllItemsFluentHelper, ConfirmPutawayOneItemFluentHelper, ConfirmPutawayOneItemFluentHelper, ConfirmPutawayOneItemFluentHelper, ConfirmPutawayOneItemFluentHelper, ConfirmWarehouseTaskExactFluentHelper, ConfirmWarehouseTaskHUFluentHelper, ConfirmWarehouseTaskProductFluentHelper, ConvertPlannedOrderFluentHelper, ConvertPlndOrderFluentHelper, ConvertPlndOrderFluentHelper, ConvertPlndOrderFluentHelper, ConvertPlndOrderFluentHelper, ConvertPlndOrderFluentHelper, CreateAllgnCompChangeStateFluentHelper, CreateBatchSplitItemFluentHelper, CreateCompositionChangeStateFluentHelper, CreateCorrectionDeliveryFluentHelper, CreateFromRFQFluentHelper, CreateFromRFQFluentHelper, CreateNtrntCompChangeStateFluentHelper, CreateStdCompChangeStateFluentHelper, CreateUrlAsAttachmentFluentHelper, CreateUrlAsAttachmentFluentHelper, DeclareInvoiceFluentHelper, DeclareInvoiceFluentHelper, DeleteActiveTimeSeriesFluentHelper, DeleteActiveTimeSeriesFluentHelper, DeleteActvCharcValCombinationFluentHelper, DeleteActvCharcValCombinationFluentHelper, DeleteAllHandlingUnitsFromDeliveryFluentHelper, DeleteAllSerialNumbersFromDeliveryItemFluentHelper, DeleteAllSerialNumbersFromDeliveryItemFluentHelper, DeleteBOMHdrWithChangeNumberFluentHelper, DeleteBOMHdrWithChangeNumberFluentHelper, DeleteBOMHeaderWithECNFluentHelper, DeleteBOMHeaderWithECNFluentHelper, DeleteBOMItemWithChangeNumberFluentHelper, DeleteBOMItemWithChangeNumberFluentHelper, DeleteBOMItemWithECNFluentHelper, DeleteBOMItemWithECNFluentHelper, DeleteFluentHelper, DeletePhysicalInventoryItemFluentHelper, DeleteSequenceAssignmentFluentHelper, DeleteSequenceAssignmentFluentHelper, DeleteSerialNumberFromDeliveryItemFluentHelper, DeleteSerialNumberFromDeliveryItemFluentHelper, DeletionFlagOrderFluentHelper, DeletionFlagOrderFluentHelper, DeletionFlagOrderFluentHelper, DeletionFlagOrderFluentHelper, DeletionFlagOrderFluentHelper, DeletionIndOrderFluentHelper, DeletionIndOrderFluentHelper, DeletionIndOrderFluentHelper, DeletionIndOrderFluentHelper, DeletionIndOrderFluentHelper, DeliveryCompletedOrderFluentHelper, DeliveryCompletedOrderFluentHelper, DeliveryCompletedOrderFluentHelper, DeliveryCompletedOrderFluentHelper, DetermineAvailabilityAtFluentHelper, DetermineAvailabilityAtFluentHelper, DetermineAvailabilityOfFluentHelper, DetermineAvailabilityOfFluentHelper, DiscardFluentHelper, DiscardFluentHelper, DiscardFromPurchasingFluentHelper, DiscardFromPurchasingFluentHelper, DiscardOrderFluentHelper, DiscardOrderFluentHelper, DiscardOrderFluentHelper, DiscardOrderFluentHelper, DiscardOrderFluentHelper, DiscardOrderFluentHelper, DismantleEquipmentFluentHelper, DismantleEquipmentFluentHelper, DismantleEquipWithDataTransferFluentHelper, EnableForPurchasingFluentHelper, EnableForPurchasingFluentHelper, ExplodeBOMFluentHelper, ExplodeBOMFluentHelper, ExplodeBOMFluentHelper, Get_IcmCacheFluentHelper, Get_PrintOptionsFluentHelper, Get_PrintQueuesOfUserFluentHelper, Get_QItem_DocumentFluentHelper, GetAllOriginalsFluentHelper, GetAllOriginalsFluentHelper, GetAttachmentCountFluentHelper, GetAttachmentCountFluentHelper, GetAttachmentLinksFluentHelper, GetBusinessPlaceFieldPropertiesFluentHelper, GetConfProposalFluentHelper, GetConfProposalFluentHelper, GetGdsMvtProposalFluentHelper, GetGdsMvtProposalFluentHelper, GetPDFFluentHelper, GetPDFFluentHelper, HeaderReleaseFluentHelper, HeaderReleaseFluentHelper, InitiateRecountFluentHelper, InitiateRecountFluentHelper, InitiateRecountOnItemFluentHelper, InitiateRecountOnItemFluentHelper, InsertAndAdjustStkLvlIntervalFluentHelper, InspectionSubsetTrigger_valuationFluentHelper, InstallEquipmentFluentHelper, InstallEquipmentFluentHelper, InstallEquipWithDataTransferFluentHelper, InventoryPriceChangeFluentHelper, InventoryPriceChangeFluentHelper, ItemReleaseFluentHelper, ItemReleaseFluentHelper, JobAbortFluentHelper, JobCancelFluentHelper, JobScheduleFluentHelper, JobStatusGetFluentHelper, LogoffFromWarehouseResourceFluentHelper, LogonToWarehouseResourceFluentHelper, PickAllItemsFluentHelper, PickAllItemsFluentHelper, PickAndBatchSplitOneItemFluentHelper, PickOneItemFluentHelper, PickOneItemFluentHelper, PickOneItemWithBaseQuantityFluentHelper, PickOneItemWithSalesQuantityFluentHelper, PlannedOrderScheduleFluentHelper, PlannedOrderScheduleFluentHelper, Post_manual_accrualsFluentHelper, PostDifferencesFluentHelper, PostDifferencesFluentHelper, PostDifferencesOnItemFluentHelper, PostDifferencesOnItemFluentHelper, PostGoodsIssueFluentHelper, PostGoodsIssueFluentHelper, PostGoodsIssueFluentHelper, PostGoodsReceiptFluentHelper, PostGoodsReceiptFluentHelper, PostGoodsReceiptFluentHelper, PostGoodsReceiptFluentHelper, PostGoodsReceiptFluentHelper, PrintLoadingListFluentHelper, PutawayAllItemsFluentHelper, PutawayAllItemsFluentHelper, PutawayAllItemsFluentHelper, PutawayAllItemsFluentHelper, PutawayOneItemFluentHelper, PutawayOneItemFluentHelper, PutawayOneItemFluentHelper, PutawayOneItemFluentHelper, PutawayOneItemWithBaseQuantityFluentHelper, PutawayOneItemWithBaseQuantityFluentHelper, PutawayOneItemWithSalesQuantityFluentHelper, PutawayOneItemWithSalesQuantityFluentHelper, ReceiveInvoiceFluentHelper, ReceiveInvoiceFluentHelper, ReDistributeFluentHelper, RejectApprovalRequestFluentHelper, RejectApprovalRequestFluentHelper, RejectApprovalRequestFluentHelper, RejectApprovalRequestFluentHelper, RejectApprovalRequestFluentHelper, RejectApprovalRequestFluentHelper, RejectApprovalRequestFluentHelper, RejectApprovalRequestFluentHelper, RejectApprovalRequestFluentHelper, RejectApprovalRequestFluentHelper, RejectCreditBlockFluentHelper, RejectCreditBlockFluentHelper, RejectCreditBlockFluentHelper, RejectCreditBlockFluentHelper, RejectFluentHelper, RejectFluentHelper, RejectItemFluentHelper, ReleaseApprovalRequestFluentHelper, ReleaseApprovalRequestFluentHelper, ReleaseApprovalRequestFluentHelper, ReleaseApprovalRequestFluentHelper, ReleaseApprovalRequestFluentHelper, ReleaseApprovalRequestFluentHelper, ReleaseApprovalRequestFluentHelper, ReleaseApprovalRequestFluentHelper, ReleaseApprovalRequestFluentHelper, ReleaseApprovalRequestFluentHelper, ReleaseCreditBlockFluentHelper, ReleaseCreditBlockFluentHelper, ReleaseCreditBlockFluentHelper, ReleaseCreditBlockFluentHelper, ReleaseFluentHelper, ReleaseFluentHelper, ReleaseOperationFluentHelper, ReleaseOperationFluentHelper, ReleaseOperationFluentHelper, ReleaseOperationFluentHelper, ReleaseOperationFluentHelper, ReleaseOrderFluentHelper, ReleaseOrderFluentHelper, ReleaseOrderFluentHelper, ReleaseOrderFluentHelper, ReleaseOrderFluentHelper, ReleaseProductionOrderFluentHelper, ReleaseProductionOrderOprFluentHelper, ReleaseVersionBOMFluentHelper, ReleaseVersionBOMFluentHelper, ReleaseVersionBOMFluentHelper, RenameAttachmentFluentHelper, RenameAttachmentFluentHelper, RequestClarificationFluentHelper, ResumeFluentHelper, ResumeFluentHelper, RetrieveNextQueueItemFluentHelper, ReverseGoodsIssueFluentHelper, ReverseGoodsIssueFluentHelper, ReverseGoodsIssueFluentHelper, ReverseGoodsReceiptFluentHelper, ReverseGoodsReceiptFluentHelper, ReverseGoodsReceiptFluentHelper, ReverseGoodsReceiptFluentHelper, ReverseGoodsReceiptFluentHelper, RevokeApprovalFluentHelper, RevokeApprovalFluentHelper, SchedulePlannedOrderOperationFluentHelper, SchedulePlannedOrderOperationFluentHelper, ScheduleProcessOrderOperationFluentHelper, ScheduleProcessOrderOperationFluentHelper, ScheduleProcessOrderOperationFluentHelper, ScheduleProductionOrderOperationFluentHelper, ScheduleProductionOrderOperationFluentHelper, ScheduleProductionOrderOperationFluentHelper, SendActionStatusFluentHelper, SendActionStatusFluentHelper, SendFluentHelper, Set_PrintParameterFluentHelper, Set_QItem_StatusFluentHelper, SetDeltnFlagProdnOrdFluentHelper, SetDeltnIndProdnOrdFluentHelper, SetInProcessWarehouseOrderFluentHelper, SetKanbanContainerLockFluentHelper, SetKanbanContainerLockFluentHelper, SetKanbanContainerStatusFluentHelper, SetKanbanContainerStatusFluentHelper, SetKanbanControlCycleLifeCycleStatusFluentHelper, SetKanbanControlCycleLifeCycleStatusFluentHelper, SetLifecycleStatusToActiveFluentHelper, SetLifecycleStatusToActiveFluentHelper, SetLifecycleStatusToInactiveFluentHelper, SetLifecycleStatusToInactiveFluentHelper, SetMaintNotifToInProcessFluentHelper, SetPickingQuantityWithBaseQuantityFluentHelper, SetProcessingStatusFluentHelper, SetProjElemProcessingStatusFluentHelper, SetPutawayQuantityWithBaseQuantityFluentHelper, SetPutawayQuantityWithBaseQuantityFluentHelper, ShiftValidityStartDateOfChangeMasterFluentHelper, ShiftValidityStartDateOfChangeMasterFluentHelper, SignoffInvoiceFluentHelper, SignoffInvoiceFluentHelper, SplitStockLevelIntervalFluentHelper, StartReconcileFluentHelper, SubmitFluentHelper, SubmitFluentHelper, SubmitFluentHelper, SubmitForApprovalFluentHelper, SubmitForApprovalFluentHelper, SubmitForApprovalFluentHelper, SubmitForApprovalFluentHelper, SubmitForApprovalFluentHelper, SubmitForApprovalFluentHelper, SuspendFluentHelper, SuspendFluentHelper, TechlyCmpltOrderFluentHelper, TechlyCmpltOrderFluentHelper, TechlyCmpltOrderFluentHelper, TechlyCmpltOrderFluentHelper, TechlyCmpltOrderFluentHelper, TerminateFluentHelper, TerminateFluentHelper, UnassignAltDateFromDocInfoRecdObjMgmtRecFluentHelper, UnassignAltDateFromDocInfoRecdObjMgmtRecFluentHelper, UnassignAltDateFromMaterialObjMgmtRecFluentHelper, UnassignAltDateFromMaterialObjMgmtRecFluentHelper, UnassignAltDateFromMatlBOMObjMgmtRecFluentHelper, UnassignAltDateFromMatlBOMObjMgmtRecFluentHelper, UnassignAlternativeDateFromObjMgmtRecordFluentHelper, UnassignAlternativeDateFromObjMgmtRecordFluentHelper, UnassignWarehouseOrderFluentHelper, UpdateGTICustomerFluentHelper, ValidateFluentHelper, ValidateFluentHelper, WithdrawFromApprovalFluentHelper, WithdrawFromApprovalFluentHelper, WithdrawFromApprovalFluentHelper, WithdrawFromApprovalFluentHelper, WithdrawFromApprovalFluentHelper, WithdrawFromApprovalFluentHelper, WithdrawQuantityFromControlCycleFluentHelper, WithdrawQuantityFromControlCycleFluentHelper, WithdrawQuantityFromKanbanContainerFluentHelper, WithdrawQuantityFromKanbanContainerFluentHelper

public abstract class FluentHelperFunction<FluentHelperT,ObjectT,ResultT>
extends FluentHelperBasic<FluentHelperT,ObjectT,ResultT>

Representation of any OData function import as a fluent interface for further configuring the request and executing it.

Constructor Summary

Constructors

Constructor and Description
FluentHelperFunction(String servicePath) Instantiates this fluent helper using the given service path to send the requests.

Method Summary

Modifier and Type	Method and Description
protected abstract org.apache.http.client.methods.HttpUriRequest	createRequest(URI uri) Creates a request for this function based on the given URI.
protected List<ObjectT>	executeMultiple(HttpDestinationProperties destination) Default implementation for the case that this function returns a collection of entries.
ResultT	executeRequest(HttpDestinationProperties destination) Executes function import request.
protected ObjectT	executeSingle(HttpDestinationProperties destination) Default implementation for the case that this function returns a single type.
protected abstract String	getFunctionName() The exact name of the function to be called on the OData Endpoint.
protected String	getJsonResponseObjectName() Deprecated. In order to customize JSON response parsing, use refineJsonResponse(com.google.gson.JsonElement) instead.
protected abstract 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.
ODataRequestGeneric	toRequest() Translate this OData v2 request into a OData request object extending ODataRequestGeneric.

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

and, cachingMetadata, execute, getEntityClass, 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

FluentHelperFunction

public FluentHelperFunction(@Nonnull
                            String servicePath)

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

Parameters:

servicePath - The service path to direct the requests to.

Method Detail

getParameters

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

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.

Returns:

A map containing the parameter for the function call.

getFunctionName

@Nonnull
protected abstract String getFunctionName()

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

Returns:

The function name on the endpoint.

createRequest

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

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

Examples for such requests are HttpGet and HttpPost.

Parameters:

uri - The URI the request should target.

Returns:

The instantiated request.

toRequest

@Beta
 @Nonnull
public ODataRequestGeneric toRequest()

Description copied from class: FluentHelperBasic

Translate this OData v2 request into a OData request object extending ODataRequestGeneric.

Returns:

A protocol agnostic OData request instance.

executeSingle

@Nullable
protected ObjectT executeSingle(@Nonnull
                                          HttpDestinationProperties destination)
                                   throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Default implementation for the case that this function returns a single type.

This method can be used in subclasses to implement the FluentHelperBasic.execute(HttpDestinationProperties) method.

Parameters:

destination - The destination to run the function against.

Returns:

The single object returned by the function call. Returns null if the function did not return a result.

Throws:

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

executeMultiple

@Nonnull
protected List<ObjectT> executeMultiple(@Nonnull
                                                 HttpDestinationProperties destination)
                                          throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Default implementation for the case that this function returns a collection of entries.

This method can be used in subclasses to implement the FluentHelperBasic.execute(HttpDestinationProperties) method.

Parameters:

destination - The destination to run the function against.

Returns:

A list of the objects returned by the function call. Returns an empty list if the function did not return a result.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the execution of the function failed.

getJsonResponseObjectName

@Deprecated
 @Nonnull
protected String getJsonResponseObjectName()

Deprecated. In order to customize JSON response parsing, use refineJsonResponse(com.google.gson.JsonElement) instead.

Get the name of the JSON object, which contains the result entity. The default implementation uses the provided function name.

Returns:

The name of the expected JSON object

refineJsonResponse

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

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

Parameters:

jsonElement - The optional response JSON element

Returns:

The refined JSON element

executeRequest

@Nullable
public ResultT executeRequest(@Nonnull
                                        HttpDestinationProperties destination)
                                 throws ODataException

Executes function import request.

Specified by:

executeRequest in interface FluentHelperExecutable<Object>

Specified by:

executeRequest in class FluentHelperBasic<FluentHelperT,ObjectT,ResultT>

Parameters:

destination - The target system this request should be issued against.

Returns:

The function import return value

Throws:

ODataException - If the OData request execution failed. Please find the documentation for ODataException possible sub-types and error scenarios they can occur in.