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

Interface MaintenanceBillOfMaterialService

All Superinterfaces:

BatchService<MaintenanceBillOfMaterialServiceBatch>

All Known Implementing Classes:

DefaultMaintenanceBillOfMaterialService

@Deprecated
public interface MaintenanceBillOfMaterialService
extends BatchService<MaintenanceBillOfMaterialServiceBatch>

Deprecated.

The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

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 Business Accelerator Hub

Details:

OData Service:	API_MAINTENANCEBOM
API Version:	1.0.1
Minimum ERP Version:	2302
Communication Scenario:	Maintenance BOM API Integration(SAP_COM_0762)
Scope Items:	Reactive Maintenance(4HH), Proactive Maintenance(4HI), Improvement Maintenance(4VT), Operational and Overhead Maintenance(4WM)
Authentication Methods:	x509
Business Object:	Maintenance Bill Of Material

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SERVICE_PATH	Deprecated. 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	Description
BOMItemCreateFluentHelper	createBOMItem(BOMItem bOMItem)	Deprecated. Create a new BOMItem entity and save it to the S/4HANA system.
MaintBOMHeaderCreateFluentHelper	createMaintBOMHeader(MaintBOMHeader maintBOMHeader)	Deprecated. Create a new MaintBOMHeader entity and save it to the S/4HANA system.
CreateVariantBOMFluentHelper	createVariantBOM(String technicalObject, String billOfMaterialVariantUsage, String plant, String billOfMaterialCategory, String referenceObjectID, LocalDateTime headerValidityStartDate, String engineeringChangeDocument)	Deprecated. Creates a fluent helper for the CreateVariantBOM OData function import.
BOMItemDeleteFluentHelper	deleteBOMItem(BOMItem bOMItem)	Deprecated. Deletes an existing BOMItem entity in the S/4HANA system.
MaintBOMHeaderDeleteFluentHelper	deleteMaintBOMHeader(MaintBOMHeader maintBOMHeader)	Deprecated. Deletes an existing MaintBOMHeader entity in the S/4HANA system.
BOMItemFluentHelper	getAllBOMItem()	Deprecated. Fetch multiple BOMItem entities.
MaintBOMHeaderFluentHelper	getAllMaintBOMHeader()	Deprecated. Fetch multiple MaintBOMHeader entities.
BOMItemByKeyFluentHelper	getBOMItemByKey(String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialVersion, String technicalObject, String plant, String engineeringChangeDocument, String billOfMaterialVariantUsage, String billOfMaterialItemNodeNumber)	Deprecated. 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)	Deprecated. Fetch a single MaintBOMHeader entity using key fields.
GetMaintBOMItemsFluentHelper	getMaintBOMItems(String technicalObject, String billOfMaterialVariantUsage, String plant, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialVersion)	Deprecated. Creates a fluent helper for the GetMaintBOMItems OData function import.
BOMItemUpdateFluentHelper	updateBOMItem(BOMItem bOMItem)	Deprecated. Update an existing BOMItem entity and save it to the S/4HANA system.
MaintBOMHeaderUpdateFluentHelper	updateMaintBOMHeader(MaintBOMHeader maintBOMHeader)	Deprecated. Update an existing MaintBOMHeader entity and save it to the S/4HANA system.
MaintenanceBillOfMaterialService	withServicePath(String servicePath)	Deprecated. 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 Details

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

Deprecated.

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 Details

withServicePath

@Nonnull
MaintenanceBillOfMaterialService withServicePath(@Nonnull
 String servicePath)

Deprecated.

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.

getAllBOMItem

@Nonnull
BOMItemFluentHelper getAllBOMItem()

Deprecated.

Fetch multiple BOMItem entities.

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
BOMItemByKeyFluentHelper getBOMItemByKey(String billOfMaterial,
 String billOfMaterialCategory,
 String billOfMaterialVariant,
 String billOfMaterialVersion,
 String technicalObject,
 String plant,
 String engineeringChangeDocument,
 String billOfMaterialVariantUsage,
 String billOfMaterialItemNodeNumber)

Deprecated.

Fetch a single BOMItem entity using key fields.

Parameters:

billOfMaterialCategory - BOM category

Constraints: Not nullable, Maximum length: 1

billOfMaterialVersion - BOM Version

Constraints: Not nullable, Maximum length: 4

plant - Plant

Constraints: Not nullable, Maximum length: 4

engineeringChangeDocument - Change Number

Constraints: Not nullable, Maximum length: 12

billOfMaterial -

technicalObject - Material 1

Constraints: Not nullable, Maximum length: 18

billOfMaterialVariant - Alternative BOM

Constraints: Not nullable, Maximum length: 2

billOfMaterialItemNodeNumber - BOM item node number

Constraints: Not nullable, Maximum length: 8

billOfMaterialVariantUsage - BOM Usage

Constraints: Not nullable, Maximum length: 1

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
BOMItemCreateFluentHelper createBOMItem(@Nonnull
 BOMItem bOMItem)

Deprecated.

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

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
BOMItemUpdateFluentHelper updateBOMItem(@Nonnull
 BOMItem bOMItem)

Deprecated.

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

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
BOMItemDeleteFluentHelper deleteBOMItem(@Nonnull
 BOMItem bOMItem)

Deprecated.

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

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
MaintBOMHeaderFluentHelper getAllMaintBOMHeader()

Deprecated.

Fetch multiple MaintBOMHeader entities.

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
MaintBOMHeaderByKeyFluentHelper getMaintBOMHeaderByKey(String billOfMaterial,
 String billOfMaterialCategory,
 String billOfMaterialVariant,
 String billOfMaterialVersion,
 String technicalObject,
 String plant,
 String engineeringChangeDocument,
 String billOfMaterialVariantUsage)

Deprecated.

Fetch a single MaintBOMHeader entity using key fields.

Parameters:

billOfMaterialCategory - BOM category

Constraints: Not nullable, Maximum length: 1

billOfMaterialVersion - BOM Version

Constraints: Not nullable, Maximum length: 4

plant - Plant

Constraints: Not nullable, Maximum length: 4

engineeringChangeDocument - Change Number

Constraints: Not nullable, Maximum length: 12

billOfMaterial -

technicalObject - Material 1

Constraints: Not nullable, Maximum length: 18

billOfMaterialVariant - Alternative BOM

Constraints: Not nullable, Maximum length: 2

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
MaintBOMHeaderCreateFluentHelper createMaintBOMHeader(@Nonnull
 MaintBOMHeader maintBOMHeader)

Deprecated.

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

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
MaintBOMHeaderUpdateFluentHelper updateMaintBOMHeader(@Nonnull
 MaintBOMHeader maintBOMHeader)

Deprecated.

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

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
MaintBOMHeaderDeleteFluentHelper deleteMaintBOMHeader(@Nonnull
 MaintBOMHeader maintBOMHeader)

Deprecated.

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

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.

createVariantBOM

@Nonnull
CreateVariantBOMFluentHelper createVariantBOM(@Nonnull
 String technicalObject,
 @Nonnull
 String billOfMaterialVariantUsage,
 @Nonnull
 String plant,
 @Nonnull
 String billOfMaterialCategory,
 @Nonnull
 String referenceObjectID,
 @Nullable
 LocalDateTime headerValidityStartDate,
 @Nullable
 String engineeringChangeDocument)

Deprecated.

Creates a fluent helper for the CreateVariantBOM OData function import.

Parameters:

billOfMaterialCategory - BOM category

Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: BillOfMaterialCategory

plant - Plant

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Plant

headerValidityStartDate - Valid From

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: HeaderValidityStartDate

engineeringChangeDocument - Change Number

Constraints: Nullable, Maximum length: 12

Original parameter name from the Odata EDM: EngineeringChangeDocument

technicalObject - Technical Object

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: TechnicalObject

billOfMaterialVariantUsage - BOM Usage

Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: BillOfMaterialVariantUsage

referenceObjectID - Owner object ID

Constraints: Not nullable, Maximum length: 70

Original parameter name from the Odata EDM: ReferenceObjectID

Returns:

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

getMaintBOMItems

@Nonnull
GetMaintBOMItemsFluentHelper getMaintBOMItems(@Nonnull
 String technicalObject,
 @Nonnull
 String billOfMaterialVariantUsage,
 @Nonnull
 String plant,
 @Nonnull
 String billOfMaterialCategory,
 @Nonnull
 String billOfMaterialVariant,
 @Nonnull
 String billOfMaterialVersion)

Deprecated.

Creates a fluent helper for the GetMaintBOMItems OData function import.

Parameters:

billOfMaterialCategory - BOM category

Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: BillOfMaterialCategory

plant - Plant

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: Plant

billOfMaterialVersion - BOM Version

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: BillOfMaterialVersion

technicalObject - Technical Object

Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: TechnicalObject

billOfMaterialVariant - Alternative BOM

Constraints: Not nullable, Maximum length: 2

Original parameter name from the Odata EDM: BillOfMaterialVariant

billOfMaterialVariantUsage - BOM Usage

Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: BillOfMaterialVariantUsage

Returns:

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