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

Class InstallEquipWithDataTransferFluentHelper

java.lang.Object

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

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperFunction<InstallEquipWithDataTransferFluentHelper,Equipment,Equipment>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.equipment.InstallEquipWithDataTransferFluentHelper

All Implemented Interfaces:

FluentHelperCustomHttpHeader<InstallEquipWithDataTransferFluentHelper>, FluentHelperExecutable<Object>

public class InstallEquipWithDataTransferFluentHelper
extends FluentHelperFunction<InstallEquipWithDataTransferFluentHelper,Equipment,Equipment>

Fluent helper for the InstallEquipWithDataTransfer OData function import.

Constructor Summary

Constructors

Constructor and Description

InstallEquipWithDataTransferFluentHelper(String servicePath, String equipment, LocalDateTime validityEndDate, String superordinateEquipment, String functionalLocation, String equipInstallationPositionNmbr, LocalDateTime equipmentInstallationDate, LocalTime equipmentInstallationTime, Boolean locationCopyIsRequested, Boolean roomCopyIsRequested, Boolean plantSectionCopyIsRequested, Boolean workCenterCopyIsRequested, Boolean aBCIndicatorCopyIsRequested, Boolean sortFieldCopyIsRequested, Boolean businessAreaCopyIsRequested, Boolean costCenterCopyIsRequested, Boolean wBSElementCopyIsRequested, Boolean standingOrderCopyIsRequested, Boolean settlementOrderCopyIsRequested, Boolean maintPlanningPlantCopyIsReqd, Boolean maintWorkCenterCopyIsRequested, Boolean catalogProfileCopyIsRequested, Boolean salesOrganizationCopyIsReqd) Creates a fluent helper object that will execute the InstallEquipWithDataTransfer 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.
Equipment	execute(HttpDestinationProperties destination) Deprecated. Use the improved method executeRequest(HttpDestinationProperties) instead.
protected Class<Equipment>	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

InstallEquipWithDataTransferFluentHelper

public InstallEquipWithDataTransferFluentHelper(@Nonnull
                                                String servicePath,
                                                @Nonnull
                                                String equipment,
                                                @Nonnull
                                                LocalDateTime validityEndDate,
                                                @Nullable
                                                String superordinateEquipment,
                                                @Nullable
                                                String functionalLocation,
                                                @Nullable
                                                String equipInstallationPositionNmbr,
                                                @Nullable
                                                LocalDateTime equipmentInstallationDate,
                                                @Nullable
                                                LocalTime equipmentInstallationTime,
                                                @Nullable
                                                Boolean locationCopyIsRequested,
                                                @Nullable
                                                Boolean roomCopyIsRequested,
                                                @Nullable
                                                Boolean plantSectionCopyIsRequested,
                                                @Nullable
                                                Boolean workCenterCopyIsRequested,
                                                @Nullable
                                                Boolean aBCIndicatorCopyIsRequested,
                                                @Nullable
                                                Boolean sortFieldCopyIsRequested,
                                                @Nullable
                                                Boolean businessAreaCopyIsRequested,
                                                @Nullable
                                                Boolean costCenterCopyIsRequested,
                                                @Nullable
                                                Boolean wBSElementCopyIsRequested,
                                                @Nullable
                                                Boolean standingOrderCopyIsRequested,
                                                @Nullable
                                                Boolean settlementOrderCopyIsRequested,
                                                @Nullable
                                                Boolean maintPlanningPlantCopyIsReqd,
                                                @Nullable
                                                Boolean maintWorkCenterCopyIsRequested,
                                                @Nullable
                                                Boolean catalogProfileCopyIsRequested,
                                                @Nullable
                                                Boolean salesOrganizationCopyIsReqd)

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

Parameters:

maintPlanningPlantCopyIsReqd - Indicator

Constraints: Nullable

Original parameter name from the Odata EDM: MaintPlanningPlantCopyIsReqd

workCenterCopyIsRequested - Indicator

Constraints: Nullable

Original parameter name from the Odata EDM: WorkCenterCopyIsRequested

costCenterCopyIsRequested - Indicator

Constraints: Nullable

Original parameter name from the Odata EDM: CostCenterCopyIsRequested

equipment - Equipment

Constraints: Not nullable, Maximum length: 18

Original parameter name from the Odata EDM: Equipment

catalogProfileCopyIsRequested - Indicator

Constraints: Nullable

Original parameter name from the Odata EDM: CatalogProfileCopyIsRequested

wBSElementCopyIsRequested - Indicator

Constraints: Nullable

Original parameter name from the Odata EDM: WBSElementCopyIsRequested

validityEndDate - Valid To

Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: ValidityEndDate

equipmentInstallationDate - Changed On

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: EquipmentInstallationDate

salesOrganizationCopyIsReqd - Indicator

Constraints: Nullable

Original parameter name from the Odata EDM: SalesOrganizationCopyIsReqd

plantSectionCopyIsRequested - Indicator

Constraints: Nullable

Original parameter name from the Odata EDM: PlantSectionCopyIsRequested

superordinateEquipment - Superord. Equipment

Constraints: Nullable, Maximum length: 18

Original parameter name from the Odata EDM: SuperordinateEquipment

standingOrderCopyIsRequested - Indicator

Constraints: Nullable

Original parameter name from the Odata EDM: StandingOrderCopyIsRequested

maintWorkCenterCopyIsRequested - Indicator

Constraints: Nullable

Original parameter name from the Odata EDM: MaintWorkCenterCopyIsRequested

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

functionalLocation - Functional Location

Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: FunctionalLocation

equipmentInstallationTime - Time

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: EquipmentInstallationTime

businessAreaCopyIsRequested - Indicator

Constraints: Nullable

Original parameter name from the Odata EDM: BusinessAreaCopyIsRequested

settlementOrderCopyIsRequested - Indicator

Constraints: Nullable

Original parameter name from the Odata EDM: SettlementOrderCopyIsRequested

sortFieldCopyIsRequested - Indicator

Constraints: Nullable

Original parameter name from the Odata EDM: SortFieldCopyIsRequested

equipInstallationPositionNmbr - Position

Constraints: Nullable, Maximum length: 4

Original parameter name from the Odata EDM: EquipInstallationPositionNmbr

roomCopyIsRequested - Indicator

Constraints: Nullable

Original parameter name from the Odata EDM: RoomCopyIsRequested

aBCIndicatorCopyIsRequested - Indicator

Constraints: Nullable

Original parameter name from the Odata EDM: ABCIndicatorCopyIsRequested

locationCopyIsRequested - Indicator

Constraints: Nullable

Original parameter name from the Odata EDM: LocationCopyIsRequested

Method Detail

getEntityClass

@Nonnull
protected Class<Equipment> getEntityClass()

Description copied from class: FluentHelperBasic

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

Specified by:

getEntityClass in class FluentHelperBasic<InstallEquipWithDataTransferFluentHelper,Equipment,Equipment>

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<InstallEquipWithDataTransferFluentHelper,Equipment,Equipment>

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<InstallEquipWithDataTransferFluentHelper,Equipment,Equipment>

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<InstallEquipWithDataTransferFluentHelper,Equipment,Equipment>

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<InstallEquipWithDataTransferFluentHelper,Equipment,Equipment>

Parameters:

uri - The URI the request should target.

Returns:

The instantiated request.

execute

@Deprecated
 @Nullable
public Equipment 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<InstallEquipWithDataTransferFluentHelper,Equipment,Equipment>

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