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

Class DefaultMaintenanceBillOfMaterialService

java.lang.Object

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

All Implemented Interfaces:

BatchService<MaintenanceBillOfMaterialServiceBatch>, MaintenanceBillOfMaterialService

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

This service enables you to create, update, or delete the bill of material header and item. It is based on the OData protocol and can be consumed in SAP Fiori apps and on other user interfaces. The service contains header and item nodes for the bill of material. When performing an operation, the necessary information is sent in the request as a payload. All information used when creating a maintenance BOM is checked for restricted values and authorizations. .

Business Documentation

Reference: SAP API Business Hub

Details:

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

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.onpremise.datamodel.odata.services.MaintenanceBillOfMaterialService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultMaintenanceBillOfMaterialService() Creates a service using MaintenanceBillOfMaterialService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultMaintenanceBillOfMaterialServiceBatch	batch()
BOMItemCreateFluentHelper	createBOMItem(BOMItem bOMItem) Create a new BOMItem entity and save it to the S/4HANA system.
MaintBOMHeaderCreateFluentHelper	createMaintBOMHeader(MaintBOMHeader maintBOMHeader) Create a new MaintBOMHeader entity and save it to the S/4HANA system.
BOMItemDeleteFluentHelper	deleteBOMItem(BOMItem bOMItem) Deletes an existing BOMItem entity in the S/4HANA system.
MaintBOMHeaderDeleteFluentHelper	deleteMaintBOMHeader(MaintBOMHeader maintBOMHeader) Deletes an existing MaintBOMHeader entity in the S/4HANA system.
BOMItemFluentHelper	getAllBOMItem() Fetch multiple BOMItem entities.
MaintBOMHeaderFluentHelper	getAllMaintBOMHeader() Fetch multiple MaintBOMHeader entities.
BOMItemByKeyFluentHelper	getBOMItemByKey(String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialVersion, String technicalObject, String plant, String engineeringChangeDocument, String billOfMaterialVariantUsage, String billOfMaterialItemNodeNumber) Fetch a single BOMItem entity using key fields.
MaintBOMHeaderByKeyFluentHelper	getMaintBOMHeaderByKey(String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialVersion, String technicalObject, String plant, String engineeringChangeDocument, String billOfMaterialVariantUsage) Fetch a single MaintBOMHeader entity using key fields.
BOMItemUpdateFluentHelper	updateBOMItem(BOMItem bOMItem) Update an existing BOMItem entity and save it to the S/4HANA system.
MaintBOMHeaderUpdateFluentHelper	updateMaintBOMHeader(MaintBOMHeader maintBOMHeader) Update an existing MaintBOMHeader entity and save it to the S/4HANA system.
DefaultMaintenanceBillOfMaterialService	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

DefaultMaintenanceBillOfMaterialService

public DefaultMaintenanceBillOfMaterialService()

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

Method Detail

withServicePath

@Nonnull
public DefaultMaintenanceBillOfMaterialService withServicePath(@Nonnull
                                                                        String servicePath)

Description copied from interface: MaintenanceBillOfMaterialService

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 MaintenanceBillOfMaterialService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultMaintenanceBillOfMaterialServiceBatch batch()

Specified by:

batch in interface BatchService<MaintenanceBillOfMaterialServiceBatch>

getAllBOMItem

@Nonnull
public BOMItemFluentHelper getAllBOMItem()

Description copied from interface: MaintenanceBillOfMaterialService

Fetch multiple BOMItem entities.

Specified by:

getAllBOMItem in interface MaintenanceBillOfMaterialService

Returns:

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

getBOMItemByKey

@Nonnull
public BOMItemByKeyFluentHelper getBOMItemByKey(String billOfMaterial,
                                                         String billOfMaterialCategory,
                                                         String billOfMaterialVariant,
                                                         String billOfMaterialVersion,
                                                         String technicalObject,
                                                         String plant,
                                                         String engineeringChangeDocument,
                                                         String billOfMaterialVariantUsage,
                                                         String billOfMaterialItemNodeNumber)

Description copied from interface: MaintenanceBillOfMaterialService

Fetch a single BOMItem entity using key fields.

Specified by:

getBOMItemByKey in interface MaintenanceBillOfMaterialService

billOfMaterialCategory - BOM category

Constraints: Not nullable, Maximum length: 1

billOfMaterialVariant - Alternative BOM

Constraints: Not nullable, Maximum length: 2

billOfMaterialVersion - BOM Version

Constraints: Not nullable, Maximum length: 4

technicalObject - Material Number

Constraints: Not nullable, Maximum length: 40

plant - Plant

Constraints: Not nullable, Maximum length: 4

engineeringChangeDocument - Change Number

Constraints: Not nullable, Maximum length: 12

billOfMaterialVariantUsage - BOM Usage

Constraints: Not nullable, Maximum length: 1

billOfMaterialItemNodeNumber - BOM item node number

Constraints: Not nullable, Maximum length: 8

Returns:

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

createBOMItem

@Nonnull
public BOMItemCreateFluentHelper createBOMItem(@Nonnull
                                                        BOMItem bOMItem)

Description copied from interface: MaintenanceBillOfMaterialService

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

Specified by:

createBOMItem in interface MaintenanceBillOfMaterialService

Parameters:

bOMItem - BOMItem entity object that will be created in the S/4HANA system.

Returns:

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

updateBOMItem

@Nonnull
public BOMItemUpdateFluentHelper updateBOMItem(@Nonnull
                                                        BOMItem bOMItem)

Description copied from interface: MaintenanceBillOfMaterialService

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

Specified by:

updateBOMItem in interface MaintenanceBillOfMaterialService

Parameters:

bOMItem - BOMItem entity object that will be updated in the S/4HANA system.

Returns:

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

deleteBOMItem

@Nonnull
public BOMItemDeleteFluentHelper deleteBOMItem(@Nonnull
                                                        BOMItem bOMItem)

Description copied from interface: MaintenanceBillOfMaterialService

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

Specified by:

deleteBOMItem in interface MaintenanceBillOfMaterialService

Parameters:

bOMItem - BOMItem entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllMaintBOMHeader

@Nonnull
public MaintBOMHeaderFluentHelper getAllMaintBOMHeader()

Description copied from interface: MaintenanceBillOfMaterialService

Fetch multiple MaintBOMHeader entities.

Specified by:

getAllMaintBOMHeader in interface MaintenanceBillOfMaterialService

Returns:

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

getMaintBOMHeaderByKey

@Nonnull
public MaintBOMHeaderByKeyFluentHelper getMaintBOMHeaderByKey(String billOfMaterial,
                                                                       String billOfMaterialCategory,
                                                                       String billOfMaterialVariant,
                                                                       String billOfMaterialVersion,
                                                                       String technicalObject,
                                                                       String plant,
                                                                       String engineeringChangeDocument,
                                                                       String billOfMaterialVariantUsage)

Description copied from interface: MaintenanceBillOfMaterialService

Fetch a single MaintBOMHeader entity using key fields.

Specified by:

getMaintBOMHeaderByKey in interface MaintenanceBillOfMaterialService

billOfMaterialCategory - BOM category

Constraints: Not nullable, Maximum length: 1

billOfMaterialVariant - Alternative BOM

Constraints: Not nullable, Maximum length: 2

billOfMaterialVersion - BOM Version

Constraints: Not nullable, Maximum length: 4

technicalObject - Material Number

Constraints: Not nullable, Maximum length: 40

plant - Plant

Constraints: Not nullable, Maximum length: 4

engineeringChangeDocument - Change Number

Constraints: Not nullable, Maximum length: 12

billOfMaterialVariantUsage - BOM Usage

Constraints: Not nullable, Maximum length: 1

Returns:

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

createMaintBOMHeader

@Nonnull
public MaintBOMHeaderCreateFluentHelper createMaintBOMHeader(@Nonnull
                                                                      MaintBOMHeader maintBOMHeader)

Description copied from interface: MaintenanceBillOfMaterialService

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

Specified by:

createMaintBOMHeader in interface MaintenanceBillOfMaterialService

Parameters:

maintBOMHeader - MaintBOMHeader entity object that will be created in the S/4HANA system.

Returns:

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

updateMaintBOMHeader

@Nonnull
public MaintBOMHeaderUpdateFluentHelper updateMaintBOMHeader(@Nonnull
                                                                      MaintBOMHeader maintBOMHeader)

Description copied from interface: MaintenanceBillOfMaterialService

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

Specified by:

updateMaintBOMHeader in interface MaintenanceBillOfMaterialService

Parameters:

maintBOMHeader - MaintBOMHeader entity object that will be updated in the S/4HANA system.

Returns:

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

deleteMaintBOMHeader

@Nonnull
public MaintBOMHeaderDeleteFluentHelper deleteMaintBOMHeader(@Nonnull
                                                                      MaintBOMHeader maintBOMHeader)

Description copied from interface: MaintenanceBillOfMaterialService

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

Specified by:

deleteMaintBOMHeader in interface MaintenanceBillOfMaterialService

Parameters:

maintBOMHeader - MaintBOMHeader entity object that will be deleted in the S/4HANA system.

Returns:

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