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

Class DefaultOrderBillOfMaterialService

java.lang.Object

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

All Implemented Interfaces:

BatchService<OrderBillOfMaterialServiceBatch>, OrderBillOfMaterialService

@Named(value="com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.DefaultOrderBillOfMaterialService")
public class DefaultOrderBillOfMaterialService
extends Object
implements OrderBillOfMaterialService

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 inherited from interface com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.OrderBillOfMaterialService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultOrderBillOfMaterialService() Creates a service using OrderBillOfMaterialService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultOrderBillOfMaterialServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultOrderBillOfMaterialService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultOrderBillOfMaterialService

public DefaultOrderBillOfMaterialService()

Creates a service using OrderBillOfMaterialService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultOrderBillOfMaterialService withServicePath(@Nonnull
                                                                  String servicePath)

Description copied from interface: OrderBillOfMaterialService

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

Specified by:

withServicePath in interface OrderBillOfMaterialService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultOrderBillOfMaterialServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<OrderBillOfMaterialServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllBOMItemCategory

@Nonnull
public BOMItemCategoryFluentHelper getAllBOMItemCategory()

Description copied from interface: OrderBillOfMaterialService

Fetch multiple BOMItemCategory entities.

Specified by:

getAllBOMItemCategory in interface OrderBillOfMaterialService

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
public BOMItemCategoryByKeyFluentHelper getBOMItemCategoryByKey(String billOfMaterialItemCategory)

Description copied from interface: OrderBillOfMaterialService

Fetch a single BOMItemCategory entity using key fields.

Specified by:

getBOMItemCategoryByKey in interface OrderBillOfMaterialService

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
public BOMItemCategoryTextFluentHelper getAllBOMItemCategoryText()

Description copied from interface: OrderBillOfMaterialService

Fetch multiple BOMItemCategoryText entities.

Specified by:

getAllBOMItemCategoryText in interface OrderBillOfMaterialService

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
public BOMItemCategoryTextByKeyFluentHelper getBOMItemCategoryTextByKey(String language,
                                                                                 String billOfMaterialItemCategory)

Description copied from interface: OrderBillOfMaterialService

Fetch a single BOMItemCategoryText entity using key fields.

Specified by:

getBOMItemCategoryTextByKey in interface OrderBillOfMaterialService

Parameters:

language - Language Key

Constraints: Not nullable, Maximum length: 2

billOfMaterialItemCategory - Item category (bill of material)

Constraints: Not nullable, Maximum length: 1

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
public SalesOrderBOMItemFluentHelper getAllSalesOrderBOMItem()

Description copied from interface: OrderBillOfMaterialService

Fetch multiple SalesOrderBOMItem entities.

Specified by:

getAllSalesOrderBOMItem in interface OrderBillOfMaterialService

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
public SalesOrderBOMItemByKeyFluentHelper getSalesOrderBOMItemByKey(String billOfMaterial,
                                                                             String billOfMaterialCategory,
                                                                             String billOfMaterialVariant,
                                                                             String billOfMaterialItemNodeNumber,
                                                                             String headerChangeDocument,
                                                                             String material,
                                                                             String plant)

Description copied from interface: OrderBillOfMaterialService

Fetch a single SalesOrderBOMItem entity using key fields.

Specified by:

getSalesOrderBOMItemByKey in interface OrderBillOfMaterialService

Parameters:

billOfMaterial - Bill of Material

Constraints: Not nullable, Maximum length: 8

billOfMaterialCategory - BOM category

Constraints: Not nullable, Maximum length: 1

billOfMaterialVariant - Alternative BOM

Constraints: Not nullable, Maximum length: 2

billOfMaterialItemNodeNumber - BOM item node number

Constraints: Not nullable, Maximum length: 8

headerChangeDocument - Change Number

Constraints: Not nullable, Maximum length: 12

material - Material Number

Constraints: Not nullable, Maximum length: 40

plant - Plant

Constraints: Not nullable, Maximum length: 4

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
public SalesOrderBOMItemCreateFluentHelper createSalesOrderBOMItem(@Nonnull
                                                                            SalesOrderBOMItem salesOrderBOMItem)

Description copied from interface: OrderBillOfMaterialService

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

Specified by:

createSalesOrderBOMItem in interface OrderBillOfMaterialService

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
public SalesOrderBOMItemUpdateFluentHelper updateSalesOrderBOMItem(@Nonnull
                                                                            SalesOrderBOMItem salesOrderBOMItem)

Description copied from interface: OrderBillOfMaterialService

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

Specified by:

updateSalesOrderBOMItem in interface OrderBillOfMaterialService

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
public SalesOrderBOMItemDeleteFluentHelper deleteSalesOrderBOMItem(@Nonnull
                                                                            SalesOrderBOMItem salesOrderBOMItem)

Description copied from interface: OrderBillOfMaterialService

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

Specified by:

deleteSalesOrderBOMItem in interface OrderBillOfMaterialService

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
public SalesOrderBOMFluentHelper getAllSalesOrderBOM()

Description copied from interface: OrderBillOfMaterialService

Fetch multiple SalesOrderBOM entities.

Specified by:

getAllSalesOrderBOM in interface OrderBillOfMaterialService

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
public SalesOrderBOMByKeyFluentHelper getSalesOrderBOMByKey(String billOfMaterialCategory,
                                                                     String billOfMaterial,
                                                                     String billOfMaterialVariant,
                                                                     String engineeringChangeDocument,
                                                                     String material,
                                                                     String plant)

Description copied from interface: OrderBillOfMaterialService

Fetch a single SalesOrderBOM entity using key fields.

Specified by:

getSalesOrderBOMByKey in interface OrderBillOfMaterialService

Parameters:

billOfMaterialCategory - BOM category

Constraints: Not nullable, Maximum length: 1

billOfMaterial - Bill of Material

Constraints: Not nullable, Maximum length: 8

billOfMaterialVariant - Alternative BOM

Constraints: Not nullable, Maximum length: 2

engineeringChangeDocument - Change Number

Constraints: Not nullable, Maximum length: 12

material - Material Number

Constraints: Not nullable, Maximum length: 40

plant - Plant

Constraints: Not nullable, Maximum length: 4

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
public SalesOrderBOMCreateFluentHelper createSalesOrderBOM(@Nonnull
                                                                    SalesOrderBOM salesOrderBOM)

Description copied from interface: OrderBillOfMaterialService

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

Specified by:

createSalesOrderBOM in interface OrderBillOfMaterialService

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
public SalesOrderBOMUpdateFluentHelper updateSalesOrderBOM(@Nonnull
                                                                    SalesOrderBOM salesOrderBOM)

Description copied from interface: OrderBillOfMaterialService

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

Specified by:

updateSalesOrderBOM in interface OrderBillOfMaterialService

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
public SalesOrderBOMDeleteFluentHelper deleteSalesOrderBOM(@Nonnull
                                                                    SalesOrderBOM salesOrderBOM)

Description copied from interface: OrderBillOfMaterialService

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

Specified by:

deleteSalesOrderBOM in interface OrderBillOfMaterialService

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
public DeleteBOMItemWithChangeNumberFluentHelper deleteBOMItemWithChangeNumber(String billOfMaterial,
                                                                                        String billOfMaterialCategory,
                                                                                        String billOfMaterialVariant,
                                                                                        String billOfMaterialItemNodeNumber,
                                                                                        String headerChangeDocument,
                                                                                        String material,
                                                                                        String plant,
                                                                                        String engineeringChangeDocForEdit)

Description copied from interface: OrderBillOfMaterialService

Creates a fluent helper for the DeleteBOMItemWithChangeNumber OData function import.

Specified by:

deleteBOMItemWithChangeNumber in interface OrderBillOfMaterialService

Parameters:

billOfMaterial - Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: BillOfMaterial

billOfMaterialCategory - Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: BillOfMaterialCategory

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

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

plant - Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Plant

engineeringChangeDocForEdit - Constraints: Nullable, Maximum length: 12

Original parameter name from the Odata EDM: EngineeringChangeDocForEdit

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
public DeleteBOMHdrWithChangeNumberFluentHelper deleteBOMHdrWithChangeNumber(String billOfMaterialCategory,
                                                                                      String billOfMaterial,
                                                                                      String billOfMaterialVariant,
                                                                                      String engineeringChangeDocument,
                                                                                      String material,
                                                                                      String plant,
                                                                                      String engineeringChangeDocForEdit)

Description copied from interface: OrderBillOfMaterialService

Creates a fluent helper for the DeleteBOMHdrWithChangeNumber OData function import.

Specified by:

deleteBOMHdrWithChangeNumber in interface OrderBillOfMaterialService

Parameters:

billOfMaterialCategory - Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: BillOfMaterialCategory

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

engineeringChangeDocument - Constraints: Not nullable, Maximum length: 12

Original parameter name from the Odata EDM: EngineeringChangeDocument

material - Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: Material

plant - Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Plant

engineeringChangeDocForEdit - Constraints: Nullable, Maximum length: 12

Original parameter name from the Odata EDM: EngineeringChangeDocForEdit

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.