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

Interface OrderBillOfMaterialService

All Superinterfaces:

BatchService<OrderBillOfMaterialServiceBatch>

All Known Implementing Classes:

DefaultOrderBillOfMaterialService

public interface OrderBillOfMaterialService
extends BatchService<OrderBillOfMaterialServiceBatch>

The service contains either no header, one header, or multiple headers for the specified order bill of material and zero or more items for each header. The required information is sent in the request as a payload to create, update, or delete order bill of material and items, make appropriate checks for restricted values. If there are any issues when the order bill of material is created, updated, or deleted, the system displays error messages in the response. The service is based on the OData protocol and can be consumed in SAP Fiori apps and on other user interfaces. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_ORDER_BILL_OF_MATERIAL_SRV_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Bill Of Material

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
SalesOrderBOMCreateFluentHelper	createSalesOrderBOM(SalesOrderBOM salesOrderBOM) Create a new SalesOrderBOM entity and save it to the S/4HANA system.
SalesOrderBOMItemCreateFluentHelper	createSalesOrderBOMItem(SalesOrderBOMItem salesOrderBOMItem) Create a new SalesOrderBOMItem entity and save it to the S/4HANA system.
DeleteBOMHdrWithChangeNumberFluentHelper	deleteBOMHdrWithChangeNumber(String billOfMaterialCategory, String billOfMaterial, String billOfMaterialVariant, String engineeringChangeDocument, String material, String plant, String engineeringChangeDocForEdit) Creates a fluent helper for the DeleteBOMHdrWithChangeNumber OData function import.
DeleteBOMItemWithChangeNumberFluentHelper	deleteBOMItemWithChangeNumber(String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialItemNodeNumber, String headerChangeDocument, String material, String plant, String engineeringChangeDocForEdit) Creates a fluent helper for the DeleteBOMItemWithChangeNumber OData function import.
SalesOrderBOMDeleteFluentHelper	deleteSalesOrderBOM(SalesOrderBOM salesOrderBOM) Deletes an existing SalesOrderBOM entity in the S/4HANA system.
SalesOrderBOMItemDeleteFluentHelper	deleteSalesOrderBOMItem(SalesOrderBOMItem salesOrderBOMItem) Deletes an existing SalesOrderBOMItem entity in the S/4HANA system.
BOMItemCategoryFluentHelper	getAllBOMItemCategory() Fetch multiple BOMItemCategory entities.
BOMItemCategoryTextFluentHelper	getAllBOMItemCategoryText() Fetch multiple BOMItemCategoryText entities.
SalesOrderBOMFluentHelper	getAllSalesOrderBOM() Fetch multiple SalesOrderBOM entities.
SalesOrderBOMItemFluentHelper	getAllSalesOrderBOMItem() Fetch multiple SalesOrderBOMItem entities.
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.
SalesOrderBOMByKeyFluentHelper	getSalesOrderBOMByKey(String billOfMaterialCategory, String billOfMaterial, String billOfMaterialVariant, String engineeringChangeDocument, String material, String plant) Fetch a single SalesOrderBOM entity using key fields.
SalesOrderBOMItemByKeyFluentHelper	getSalesOrderBOMItemByKey(String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialItemNodeNumber, String headerChangeDocument, String material, String plant) Fetch a single SalesOrderBOMItem entity using key fields.
SalesOrderBOMUpdateFluentHelper	updateSalesOrderBOM(SalesOrderBOM salesOrderBOM) Update an existing SalesOrderBOM entity and save it to the S/4HANA system.
SalesOrderBOMItemUpdateFluentHelper	updateSalesOrderBOMItem(SalesOrderBOMItem salesOrderBOMItem) Update an existing SalesOrderBOMItem entity and save it to the S/4HANA system.
OrderBillOfMaterialService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

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
OrderBillOfMaterialService 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.

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 - Item category (bill of material)

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 - Item category (bill of material)

Constraints: Not nullable, Maximum length: 1

language - Language Key

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.

getAllSalesOrderBOMItem

@Nonnull
SalesOrderBOMItemFluentHelper getAllSalesOrderBOMItem()

Fetch multiple SalesOrderBOMItem entities.

Returns:

A fluent helper to fetch multiple SalesOrderBOMItem 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.

getSalesOrderBOMItemByKey

@Nonnull
SalesOrderBOMItemByKeyFluentHelper getSalesOrderBOMItemByKey(String billOfMaterial,
                                                                      String billOfMaterialCategory,
                                                                      String billOfMaterialVariant,
                                                                      String billOfMaterialItemNodeNumber,
                                                                      String headerChangeDocument,
                                                                      String material,
                                                                      String plant)

Fetch a single SalesOrderBOMItem entity using key fields.

Parameters:

headerChangeDocument - Change Number

Constraints: Not nullable, Maximum length: 12

material - Material Number

Constraints: Not nullable, Maximum length: 40

billOfMaterialCategory - BOM category

Constraints: Not nullable, Maximum length: 1

plant - Plant

Constraints: Not nullable, Maximum length: 4

billOfMaterial - Bill of Material

Constraints: Not nullable, Maximum length: 8

billOfMaterialVariant - Alternative BOM

Constraints: Not nullable, Maximum length: 2

billOfMaterialItemNodeNumber - BOM item node number

Constraints: Not nullable, Maximum length: 8

Returns:

A fluent helper to fetch a single SalesOrderBOMItem 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.

createSalesOrderBOMItem

@Nonnull
SalesOrderBOMItemCreateFluentHelper createSalesOrderBOMItem(@Nonnull
                                                                     SalesOrderBOMItem salesOrderBOMItem)

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

Parameters:

salesOrderBOMItem - SalesOrderBOMItem entity object that will be created in the S/4HANA system.

Returns:

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

updateSalesOrderBOMItem

@Nonnull
SalesOrderBOMItemUpdateFluentHelper updateSalesOrderBOMItem(@Nonnull
                                                                     SalesOrderBOMItem salesOrderBOMItem)

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

Parameters:

salesOrderBOMItem - SalesOrderBOMItem entity object that will be updated in the S/4HANA system.

Returns:

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

deleteSalesOrderBOMItem

@Nonnull
SalesOrderBOMItemDeleteFluentHelper deleteSalesOrderBOMItem(@Nonnull
                                                                     SalesOrderBOMItem salesOrderBOMItem)

Deletes an existing SalesOrderBOMItem entity in the S/4HANA system.

Parameters:

salesOrderBOMItem - SalesOrderBOMItem entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllSalesOrderBOM

@Nonnull
SalesOrderBOMFluentHelper getAllSalesOrderBOM()

Fetch multiple SalesOrderBOM entities.

Returns:

A fluent helper to fetch multiple SalesOrderBOM 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.

getSalesOrderBOMByKey

@Nonnull
SalesOrderBOMByKeyFluentHelper getSalesOrderBOMByKey(String billOfMaterialCategory,
                                                              String billOfMaterial,
                                                              String billOfMaterialVariant,
                                                              String engineeringChangeDocument,
                                                              String material,
                                                              String plant)

Fetch a single SalesOrderBOM entity using key fields.

Parameters:

material - Material Number

Constraints: Not nullable, Maximum length: 40

billOfMaterialCategory - BOM category

Constraints: Not nullable, Maximum length: 1

engineeringChangeDocument - Change Number

Constraints: Not nullable, Maximum length: 12

plant - Plant

Constraints: Not nullable, Maximum length: 4

billOfMaterial - Bill of Material

Constraints: Not nullable, Maximum length: 8

billOfMaterialVariant - Alternative BOM

Constraints: Not nullable, Maximum length: 2

Returns:

A fluent helper to fetch a single SalesOrderBOM 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.

createSalesOrderBOM

@Nonnull
SalesOrderBOMCreateFluentHelper createSalesOrderBOM(@Nonnull
                                                             SalesOrderBOM salesOrderBOM)

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

Parameters:

salesOrderBOM - SalesOrderBOM entity object that will be created in the S/4HANA system.

Returns:

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

updateSalesOrderBOM

@Nonnull
SalesOrderBOMUpdateFluentHelper updateSalesOrderBOM(@Nonnull
                                                             SalesOrderBOM salesOrderBOM)

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

Parameters:

salesOrderBOM - SalesOrderBOM entity object that will be updated in the S/4HANA system.

Returns:

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

deleteSalesOrderBOM

@Nonnull
SalesOrderBOMDeleteFluentHelper deleteSalesOrderBOM(@Nonnull
                                                             SalesOrderBOM salesOrderBOM)

Deletes an existing SalesOrderBOM entity in the S/4HANA system.

Parameters:

salesOrderBOM - SalesOrderBOM entity object that will be deleted in the S/4HANA system.

Returns:

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

deleteBOMItemWithChangeNumber

@Nonnull
DeleteBOMItemWithChangeNumberFluentHelper deleteBOMItemWithChangeNumber(String billOfMaterial,
                                                                                 String billOfMaterialCategory,
                                                                                 String billOfMaterialVariant,
                                                                                 String billOfMaterialItemNodeNumber,
                                                                                 String headerChangeDocument,
                                                                                 String material,
                                                                                 String plant,
                                                                                 String engineeringChangeDocForEdit)

Creates a fluent helper for the DeleteBOMItemWithChangeNumber OData function import.

Parameters:

headerChangeDocument - Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: HeaderChangeDocument

material - Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: Material

billOfMaterialCategory - Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: BillOfMaterialCategory

engineeringChangeDocForEdit - Constraints: Nullable, Maximum length: 12

Original parameter name from the Odata EDM: EngineeringChangeDocForEdit

plant - Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Plant

billOfMaterial - Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: BillOfMaterial

billOfMaterialVariant - Constraints: Not nullable, Maximum length: 2

Original parameter name from the Odata EDM: BillOfMaterialVariant

billOfMaterialItemNodeNumber - Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: BillOfMaterialItemNodeNumber

Returns:

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

deleteBOMHdrWithChangeNumber

@Nonnull
DeleteBOMHdrWithChangeNumberFluentHelper deleteBOMHdrWithChangeNumber(String billOfMaterialCategory,
                                                                               String billOfMaterial,
                                                                               String billOfMaterialVariant,
                                                                               String engineeringChangeDocument,
                                                                               String material,
                                                                               String plant,
                                                                               String engineeringChangeDocForEdit)

Creates a fluent helper for the DeleteBOMHdrWithChangeNumber OData function import.

Parameters:

material - Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: Material

billOfMaterialCategory - Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: BillOfMaterialCategory

engineeringChangeDocForEdit - Constraints: Nullable, Maximum length: 12

Original parameter name from the Odata EDM: EngineeringChangeDocForEdit

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

billOfMaterial - Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: BillOfMaterial

billOfMaterialVariant - Constraints: Not nullable, Maximum length: 2

Original parameter name from the Odata EDM: BillOfMaterialVariant

Returns:

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