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

Class ExplodeBOMFluentHelper

java.lang.Object

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

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

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

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

Fluent helper for the ExplodeBOM OData function import.

Field Summary

Fields inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.FluentHelperFunction

END_OF_ERROR_CODES, START_OF_ERROR_CODES

Constructor Summary

Constructors

Constructor and Description

ExplodeBOMFluentHelper(String servicePath, UUID billOfMaterialHeaderUUID, String material, String plant, String billOfMaterialVariant, String bOMExplosionApplication, BigDecimal requiredQuantity, String engineeringChangeDocument, Boolean bOMExplosionIsLimited, String bOMItmQtyIsScrapRelevant, String billOfMaterialItemCategory, String bOMExplosionAssembly, LocalDateTime bOMExplosionDate, BigDecimal bOMExplosionLevel, Boolean bOMExplosionIsMultilevel, String materialProvisionFltrType, String sparePartFltrType) 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<CsapSBomExplOut>	execute(ErpConfigContext configContext) Executes the underlying query using the stored values, plus any query modifiers that were previously called.
protected Class<CsapSBomExplOut>	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.

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

executeMultiple, executeSingle

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

asResilientCommand, asResilientCommand, execute, getHeadersForRequestAndImplicitRequests, getHeadersForRequestOnly, getServicePath, getThis, getVersionIdentifier, withCustomHttpHeader, withCustomHttpHeaders

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,
                              UUID billOfMaterialHeaderUUID,
                              String material,
                              String plant,
                              String billOfMaterialVariant,
                              String bOMExplosionApplication,
                              BigDecimal requiredQuantity,
                              String engineeringChangeDocument,
                              Boolean bOMExplosionIsLimited,
                              String bOMItmQtyIsScrapRelevant,
                              String billOfMaterialItemCategory,
                              String bOMExplosionAssembly,
                              LocalDateTime bOMExplosionDate,
                              BigDecimal bOMExplosionLevel,
                              Boolean bOMExplosionIsMultilevel,
                              String materialProvisionFltrType,
                              String sparePartFltrType)

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:

bOMItmQtyIsScrapRelevant - Exceptions

Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: BOMItmQtyIsScrapRelevant

sparePartFltrType - Spare part indicator

Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: SparePartFltrType

bOMExplosionLevel - Explosion level

Constraints: Not nullable, Precision: 3, Scale: 0

Original parameter name from the Odata EDM: BOMExplosionLevel

bOMExplosionIsLimited - Limited Explosion

Constraints: none

Original parameter name from the Odata EDM: BOMExplosionIsLimited

bOMExplosionApplication - BOM Application

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: BOMExplosionApplication

requiredQuantity - Base quantity

Constraints: Not nullable, Precision: 13, Scale: 3

Original parameter name from the Odata EDM: RequiredQuantity

material - Material

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: Material

billOfMaterialHeaderUUID - ID hdr chge status

Constraints: none

Original parameter name from the Odata EDM: BillOfMaterialHeaderUUID

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

plant - Plant

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Plant

engineeringChangeDocument - Change Number

Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: EngineeringChangeDocument

billOfMaterialItemCategory - Item Category

Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: BillOfMaterialItemCategory

bOMExplosionIsMultilevel - Multi-lev.

Constraints: none

Original parameter name from the Odata EDM: BOMExplosionIsMultilevel

billOfMaterialVariant - Alternative BOM

Constraints: Not nullable, Maximum length: 2

Original parameter name from the Odata EDM: BillOfMaterialVariant

materialProvisionFltrType - Mat. Provision Ind.

Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: MaterialProvisionFltrType

bOMExplosionAssembly - Material

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: BOMExplosionAssembly

bOMExplosionDate - Valid From

Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: BOMExplosionDate

Method Detail

getEntityClass

@Nonnull
protected Class<CsapSBomExplOut> 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,CsapSBomExplOut,List<CsapSBomExplOut>>

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,CsapSBomExplOut,List<CsapSBomExplOut>>

Returns:

The function name on the endpoint.

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,CsapSBomExplOut,List<CsapSBomExplOut>>

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,CsapSBomExplOut,List<CsapSBomExplOut>>

Parameters:

uri - The URI the request should target.

Returns:

The instantiated request.

execute

@Nonnull
public List<CsapSBomExplOut> execute(@Nonnull
                                              ErpConfigContext configContext)
                                       throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Description copied from class: FluentHelperBasic

Executes the underlying query using the stored values, plus any query modifiers that were previously called.

Specified by:

execute in class FluentHelperBasic<ExplodeBOMFluentHelper,CsapSBomExplOut,List<CsapSBomExplOut>>

Parameters:

configContext - Supply the ERP system context for executing the underlying OData query.

Returns:

A single entity if the query execution is successful. If the underlying OData request fails, then an ODataException is thrown, and the error handler class attached to this fluent helper will be called.

Throws:

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

See Also:

ErpConfigContext.ErpConfigContext()