com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface BillOfMaterialsService

All Known Implementing Classes:

DefaultBillOfMaterialsService

public interface BillOfMaterialsService

This service enables you to read, create and update Bills of Material and Version Bills of Material. It is based on the OData protocol and can be consumed in SAP Fiori apps and on other user interfaces. The service contains either no header, one header or multiple headers for the specified material and zero or more items for each header. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_BILL_OF_MATERIAL_SRV
API Version:	1
Communication Scenario:	Product Lifecycle Management - Master Data Integration (SAP_COM_0105)
Scope Items:	Engineering Bill of Material - Versions Management (1NR), Engineering Bill of Material - Change Master Management (1R3)
Authentication Methods:	Basic, x509

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
BillOfMaterialCreateFluentHelper	createBillOfMaterial(BillOfMaterial billOfMaterial) Create a new BillOfMaterial entity and save it to the S/4HANA system.
BillOfMaterialItemCreateFluentHelper	createBillOfMaterialItem(BillOfMaterialItem billOfMaterialItem) Create a new BillOfMaterialItem entity and save it to the S/4HANA system.
ExplodeBOMFluentHelper	explodeBOM(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 for the ExplodeBOM OData function import.
BillOfMaterialFluentHelper	getAllBillOfMaterial() Fetch multiple BillOfMaterial entities.
BillOfMaterialItemFluentHelper	getAllBillOfMaterialItem() Fetch multiple BillOfMaterialItem entities.
BillOfMaterialUsageFluentHelper	getAllBillOfMaterialUsage() Fetch multiple BillOfMaterialUsage entities.
BillOfMaterialUsageTextFluentHelper	getAllBillOfMaterialUsageText() Fetch multiple BillOfMaterialUsageText entities.
BOMItemCategoryFluentHelper	getAllBOMItemCategory() Fetch multiple BOMItemCategory entities.
BOMItemCategoryTextFluentHelper	getAllBOMItemCategoryText() Fetch multiple BOMItemCategoryText entities.
BillOfMaterialByKeyFluentHelper	getBillOfMaterialByKey(UUID billOfMaterialHeaderUUID) Fetch a single BillOfMaterial entity using key fields.
BillOfMaterialItemByKeyFluentHelper	getBillOfMaterialItemByKey(UUID billOfMaterialItemUUID) Fetch a single BillOfMaterialItem entity using key fields.
BillOfMaterialUsageByKeyFluentHelper	getBillOfMaterialUsageByKey(String billOfMaterialVariantUsage) Fetch a single BillOfMaterialUsage entity using key fields.
BillOfMaterialUsageTextByKeyFluentHelper	getBillOfMaterialUsageTextByKey(String language, String billOfMaterialVariantUsage) Fetch a single BillOfMaterialUsageText entity using key fields.
BOMItemCategoryByKeyFluentHelper	getBOMItemCategoryByKey(String billOfMaterialItemCategory) Fetch a single BOMItemCategory entity using key fields.
BOMItemCategoryTextByKeyFluentHelper	getBOMItemCategoryTextByKey(String language, String billOfMaterialItemCategory) Fetch a single BOMItemCategoryText entity using key fields.
ReleaseVersionBOMFluentHelper	releaseVersionBOM(UUID billOfMaterialHeaderUUID, String stlnr, String stlty, String stlal, String bomVersn, String versnst, Boolean versnlastind) Creates a fluent helper for the ReleaseVersionBOM OData function import.
BillOfMaterialUpdateFluentHelper	updateBillOfMaterial(BillOfMaterial billOfMaterial) Update an existing BillOfMaterial entity and save it to the S/4HANA system.
BillOfMaterialItemUpdateFluentHelper	updateBillOfMaterialItem(BillOfMaterialItem billOfMaterialItem) Update an existing BillOfMaterialItem entity and save it to the S/4HANA system.
BillOfMaterialsService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
BillOfMaterialsService withServicePath(@Nonnull
                                                String servicePath)

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

getAllBillOfMaterial

@Nonnull
BillOfMaterialFluentHelper getAllBillOfMaterial()

Fetch multiple BillOfMaterial entities.

Returns:

A fluent helper to fetch multiple BillOfMaterial entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getBillOfMaterialByKey

@Nonnull
BillOfMaterialByKeyFluentHelper getBillOfMaterialByKey(UUID billOfMaterialHeaderUUID)

Fetch a single BillOfMaterial entity using key fields.

Parameters:

billOfMaterialHeaderUUID - Global identification of a BOM header change status

Constraints: Not nullable

Returns:

A fluent helper to fetch a single BillOfMaterial entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

createBillOfMaterial

@Nonnull
BillOfMaterialCreateFluentHelper createBillOfMaterial(@Nonnull
                                                               BillOfMaterial billOfMaterial)

Create a new BillOfMaterial entity and save it to the S/4HANA system.

Parameters:

billOfMaterial - BillOfMaterial entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new BillOfMaterial entity. To perform execution, call the execute method on the fluent helper object.

updateBillOfMaterial

@Nonnull
BillOfMaterialUpdateFluentHelper updateBillOfMaterial(@Nonnull
                                                               BillOfMaterial billOfMaterial)

Update an existing BillOfMaterial entity and save it to the S/4HANA system.

Parameters:

billOfMaterial - BillOfMaterial entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing BillOfMaterial entity. To perform execution, call the execute method on the fluent helper object.

getAllBillOfMaterialItem

@Nonnull
BillOfMaterialItemFluentHelper getAllBillOfMaterialItem()

Fetch multiple BillOfMaterialItem entities.

Returns:

A fluent helper to fetch multiple BillOfMaterialItem entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getBillOfMaterialItemByKey

@Nonnull
BillOfMaterialItemByKeyFluentHelper getBillOfMaterialItemByKey(UUID billOfMaterialItemUUID)

Fetch a single BillOfMaterialItem entity using key fields.

Parameters:

billOfMaterialItemUUID - Global identification of an item's change status

Constraints: Not nullable

Returns:

A fluent helper to fetch a single BillOfMaterialItem entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

createBillOfMaterialItem

@Nonnull
BillOfMaterialItemCreateFluentHelper createBillOfMaterialItem(@Nonnull
                                                                       BillOfMaterialItem billOfMaterialItem)

Create a new BillOfMaterialItem entity and save it to the S/4HANA system.

Parameters:

billOfMaterialItem - BillOfMaterialItem entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new BillOfMaterialItem entity. To perform execution, call the execute method on the fluent helper object.

updateBillOfMaterialItem

@Nonnull
BillOfMaterialItemUpdateFluentHelper updateBillOfMaterialItem(@Nonnull
                                                                       BillOfMaterialItem billOfMaterialItem)

Update an existing BillOfMaterialItem entity and save it to the S/4HANA system.

Parameters:

billOfMaterialItem - BillOfMaterialItem entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing BillOfMaterialItem entity. To perform execution, call the execute method on the fluent helper object.

getAllBillOfMaterialUsage

@Nonnull
BillOfMaterialUsageFluentHelper getAllBillOfMaterialUsage()

Fetch multiple BillOfMaterialUsage entities.

Returns:

A fluent helper to fetch multiple BillOfMaterialUsage entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getBillOfMaterialUsageByKey

@Nonnull
BillOfMaterialUsageByKeyFluentHelper getBillOfMaterialUsageByKey(String billOfMaterialVariantUsage)

Fetch a single BillOfMaterialUsage entity using key fields.

Parameters:

billOfMaterialVariantUsage - This key defines the area (such as engineering/design or production) where a BOM can be used.

Constraints: Not nullable, Maximum length: 1

Returns:

A fluent helper to fetch a single BillOfMaterialUsage entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getAllBillOfMaterialUsageText

@Nonnull
BillOfMaterialUsageTextFluentHelper getAllBillOfMaterialUsageText()

Fetch multiple BillOfMaterialUsageText entities.

Returns:

A fluent helper to fetch multiple BillOfMaterialUsageText entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getBillOfMaterialUsageTextByKey

@Nonnull
BillOfMaterialUsageTextByKeyFluentHelper getBillOfMaterialUsageTextByKey(String language,
                                                                                  String billOfMaterialVariantUsage)

Fetch a single BillOfMaterialUsageText entity using key fields.

Parameters:

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

billOfMaterialVariantUsage - This key defines the area (such as engineering/design or production) where a BOM can be used.

Constraints: Not nullable, Maximum length: 1

Returns:

A fluent helper to fetch a single BillOfMaterialUsageText entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getAllBOMItemCategory

@Nonnull
BOMItemCategoryFluentHelper getAllBOMItemCategory()

Fetch multiple BOMItemCategory entities.

Returns:

A fluent helper to fetch multiple BOMItemCategory entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getBOMItemCategoryByKey

@Nonnull
BOMItemCategoryByKeyFluentHelper getBOMItemCategoryByKey(String billOfMaterialItemCategory)

Fetch a single BOMItemCategory entity using key fields.

Parameters:

billOfMaterialItemCategory - Categorization of the items in a BOM according to set criteria, such as whether they refer to an object (for example, material master or document info record) or whether they are kept in stock.

Constraints: Not nullable, Maximum length: 1

Returns:

A fluent helper to fetch a single BOMItemCategory entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getAllBOMItemCategoryText

@Nonnull
BOMItemCategoryTextFluentHelper getAllBOMItemCategoryText()

Fetch multiple BOMItemCategoryText entities.

Returns:

A fluent helper to fetch multiple BOMItemCategoryText entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getBOMItemCategoryTextByKey

@Nonnull
BOMItemCategoryTextByKeyFluentHelper getBOMItemCategoryTextByKey(String language,
                                                                          String billOfMaterialItemCategory)

Fetch a single BOMItemCategoryText entity using key fields.

Parameters:

billOfMaterialItemCategory - Categorization of the items in a BOM according to set criteria, such as whether they refer to an object (for example, material master or document info record) or whether they are kept in stock.

Constraints: Not nullable, Maximum length: 1

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

Returns:

A fluent helper to fetch a single BOMItemCategoryText entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

explodeBOM

@Nonnull
ExplodeBOMFluentHelper explodeBOM(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 for the ExplodeBOM OData function import.

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

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

Returns:

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.

releaseVersionBOM

@Nonnull
ReleaseVersionBOMFluentHelper releaseVersionBOM(UUID billOfMaterialHeaderUUID,
                                                         String stlnr,
                                                         String stlty,
                                                         String stlal,
                                                         String bomVersn,
                                                         String versnst,
                                                         Boolean versnlastind)

Creates a fluent helper for the ReleaseVersionBOM OData function import.

Parameters:

stlnr - Bill of Material

Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: Stlnr

billOfMaterialHeaderUUID - ID hdr chge status

Constraints: none

Original parameter name from the Odata EDM: BillOfMaterialHeaderUUID

versnlastind - Latest Version

Constraints: none

Original parameter name from the Odata EDM: Versnlastind

stlty - BOM category

Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: Stlty

versnst - BOM Version Status

Constraints: Not nullable, Maximum length: 2

Original parameter name from the Odata EDM: Versnst

stlal - Alternative BOM

Constraints: Not nullable, Maximum length: 2

Original parameter name from the Odata EDM: Stlal

bomVersn - BOM Version

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: BomVersn

Returns:

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