com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.namespaces.billofmaterials

Class ExplodeBOMFluentHelper

java.lang.Object

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

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperFunction<ExplodeBOMFluentHelper,DBomheaderforexplosionOut,List<DBomheaderforexplosionOut>>

com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.namespaces.billofmaterials.ExplodeBOMFluentHelper

All Implemented Interfaces:

FluentHelperCustomHttpHeader<ExplodeBOMFluentHelper>, FluentHelperExecutable<Object>

public class ExplodeBOMFluentHelper
extends FluentHelperFunction<ExplodeBOMFluentHelper,DBomheaderforexplosionOut,List<DBomheaderforexplosionOut>>

Fluent helper for the ExplodeBOM OData function import.

Constructor Summary

Constructors

Constructor and Description

ExplodeBOMFluentHelper(String servicePath, String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialVersion, String engineeringChangeDocument, String material, String plant, String bOMExplosionApplication, BigDecimal requiredQuantity, Boolean bOMExplosionIsLimited, String bOMItmQtyIsScrapRelevant, String billOfMaterialItemCategory, String bOMExplosionAssembly, LocalDateTime bOMExplosionDate, BigDecimal bOMExplosionLevel, Boolean bOMExplosionIsMultilevel, String materialProvisionFltrType, String sparePartFltrType, String bOMHeaderBaseUnit, Boolean finalPriceIndicator, Boolean bOMExplosionIsAlternatePrio) Creates a fluent helper object that will execute the ExplodeBOM 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.
List<DBomheaderforexplosionOut>	execute(HttpDestinationProperties destination) Deprecated. Use the improved method executeRequest(HttpDestinationProperties) instead.
protected Class<DBomheaderforexplosionOut>	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

ExplodeBOMFluentHelper

public ExplodeBOMFluentHelper(@Nonnull
                              String servicePath,
                              String billOfMaterial,
                              String billOfMaterialCategory,
                              String billOfMaterialVariant,
                              String billOfMaterialVersion,
                              String engineeringChangeDocument,
                              String material,
                              String plant,
                              String bOMExplosionApplication,
                              BigDecimal requiredQuantity,
                              Boolean bOMExplosionIsLimited,
                              String bOMItmQtyIsScrapRelevant,
                              String billOfMaterialItemCategory,
                              String bOMExplosionAssembly,
                              LocalDateTime bOMExplosionDate,
                              BigDecimal bOMExplosionLevel,
                              Boolean bOMExplosionIsMultilevel,
                              String materialProvisionFltrType,
                              String sparePartFltrType,
                              String bOMHeaderBaseUnit,
                              Boolean finalPriceIndicator,
                              Boolean bOMExplosionIsAlternatePrio)

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

Parameters:

finalPriceIndicator - Constraints: Nullable

Original parameter name from the Odata EDM: FinalPriceIndicator

bOMItmQtyIsScrapRelevant - Constraints: Nullable, Maximum length: 1

Original parameter name from the Odata EDM: BOMItmQtyIsScrapRelevant

sparePartFltrType - Constraints: Nullable, Maximum length: 1

Original parameter name from the Odata EDM: SparePartFltrType

billOfMaterialVersion - Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: BillOfMaterialVersion

bOMExplosionLevel - Constraints: Nullable, Precision: 3, Scale: 0

Original parameter name from the Odata EDM: BOMExplosionLevel

billOfMaterial - Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: BillOfMaterial

bOMExplosionIsLimited - Constraints: Nullable

Original parameter name from the Odata EDM: BOMExplosionIsLimited

bOMExplosionApplication - Constraints: Nullable, Maximum length: 4

Original parameter name from the Odata EDM: BOMExplosionApplication

bOMHeaderBaseUnit - Constraints: Nullable, Maximum length: 3

Original parameter name from the Odata EDM: BOMHeaderBaseUnit

requiredQuantity - Constraints: Nullable, Precision: 13, Scale: 3

Original parameter name from the Odata EDM: RequiredQuantity

material - Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: Material

bOMExplosionIsAlternatePrio - Constraints: Nullable

Original parameter name from the Odata EDM: BOMExplosionIsAlternatePrio

billOfMaterialCategory - Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: BillOfMaterialCategory

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

engineeringChangeDocument - Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: EngineeringChangeDocument

plant - Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Plant

billOfMaterialItemCategory - Constraints: Nullable, Maximum length: 1

Original parameter name from the Odata EDM: BillOfMaterialItemCategory

bOMExplosionIsMultilevel - Constraints: Nullable

Original parameter name from the Odata EDM: BOMExplosionIsMultilevel

billOfMaterialVariant - Constraints: Not nullable, Maximum length: 2

Original parameter name from the Odata EDM: BillOfMaterialVariant

materialProvisionFltrType - Constraints: Nullable, Maximum length: 1

Original parameter name from the Odata EDM: MaterialProvisionFltrType

bOMExplosionAssembly - Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: BOMExplosionAssembly

bOMExplosionDate - Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: BOMExplosionDate

Method Detail

getEntityClass

@Nonnull
protected Class<DBomheaderforexplosionOut> getEntityClass()

Description copied from class: FluentHelperBasic

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

Specified by:

getEntityClass in class FluentHelperBasic<ExplodeBOMFluentHelper,DBomheaderforexplosionOut,List<DBomheaderforexplosionOut>>

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<ExplodeBOMFluentHelper,DBomheaderforexplosionOut,List<DBomheaderforexplosionOut>>

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<ExplodeBOMFluentHelper,DBomheaderforexplosionOut,List<DBomheaderforexplosionOut>>

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<ExplodeBOMFluentHelper,DBomheaderforexplosionOut,List<DBomheaderforexplosionOut>>

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<ExplodeBOMFluentHelper,DBomheaderforexplosionOut,List<DBomheaderforexplosionOut>>

Parameters:

uri - The URI the request should target.

Returns:

The instantiated request.

execute

@Deprecated
 @Nonnull
public List<DBomheaderforexplosionOut> 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<ExplodeBOMFluentHelper,DBomheaderforexplosionOut,List<DBomheaderforexplosionOut>>

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