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

Class DefaultBillOfMaterialsService

java.lang.Object

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

All Implemented Interfaces:

BillOfMaterialsService

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

This service can be used to read , create and update Bill of Material and version Bill of Material.

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 Change Master Management (1R3)

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultBillOfMaterialsService() Creates a service using BillOfMaterialsService.DEFAULT_SERVICE_PATH to send the requests.

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.
BillOfMaterialFluentHelper	getAllBillOfMaterial() Fetch multiple BillOfMaterial entities.
BillOfMaterialItemFluentHelper	getAllBillOfMaterialItem() Fetch multiple BillOfMaterialItem 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.
ReleaseVersionBOMFluentHelper	releaseVersionBOM(UUID billOfMaterialHeaderUUID, String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialVersion, String bOMVersionStatus, Boolean isLatestBOMVersion) 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.
DefaultBillOfMaterialsService	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

DefaultBillOfMaterialsService

public DefaultBillOfMaterialsService()

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

Method Detail

withServicePath

@Nonnull
public DefaultBillOfMaterialsService withServicePath(@Nonnull
                                                               String servicePath)

Description copied from interface: BillOfMaterialsService

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 BillOfMaterialsService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path

getAllBillOfMaterial

@Nonnull
public BillOfMaterialFluentHelper getAllBillOfMaterial()

Description copied from interface: BillOfMaterialsService

Fetch multiple BillOfMaterial entities.

Specified by:

getAllBillOfMaterial in interface BillOfMaterialsService

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
public BillOfMaterialByKeyFluentHelper getBillOfMaterialByKey(UUID billOfMaterialHeaderUUID)

Description copied from interface: BillOfMaterialsService

Fetch a single BillOfMaterial entity using key fields.

Specified by:

getBillOfMaterialByKey in interface BillOfMaterialsService

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
public BillOfMaterialCreateFluentHelper createBillOfMaterial(@Nonnull
                                                                       BillOfMaterial billOfMaterial)

Description copied from interface: BillOfMaterialsService

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

Specified by:

createBillOfMaterial in interface BillOfMaterialsService

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
public BillOfMaterialUpdateFluentHelper updateBillOfMaterial(@Nonnull
                                                                       BillOfMaterial billOfMaterial)

Description copied from interface: BillOfMaterialsService

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

Specified by:

updateBillOfMaterial in interface BillOfMaterialsService

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
public BillOfMaterialItemFluentHelper getAllBillOfMaterialItem()

Description copied from interface: BillOfMaterialsService

Fetch multiple BillOfMaterialItem entities.

Specified by:

getAllBillOfMaterialItem in interface BillOfMaterialsService

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
public BillOfMaterialItemByKeyFluentHelper getBillOfMaterialItemByKey(UUID billOfMaterialItemUUID)

Description copied from interface: BillOfMaterialsService

Fetch a single BillOfMaterialItem entity using key fields.

Specified by:

getBillOfMaterialItemByKey in interface BillOfMaterialsService

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
public BillOfMaterialItemCreateFluentHelper createBillOfMaterialItem(@Nonnull
                                                                               BillOfMaterialItem billOfMaterialItem)

Description copied from interface: BillOfMaterialsService

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

Specified by:

createBillOfMaterialItem in interface BillOfMaterialsService

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
public BillOfMaterialItemUpdateFluentHelper updateBillOfMaterialItem(@Nonnull
                                                                               BillOfMaterialItem billOfMaterialItem)

Description copied from interface: BillOfMaterialsService

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

Specified by:

updateBillOfMaterialItem in interface BillOfMaterialsService

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.

releaseVersionBOM

@Nonnull
public ReleaseVersionBOMFluentHelper releaseVersionBOM(UUID billOfMaterialHeaderUUID,
                                                                 String billOfMaterial,
                                                                 String billOfMaterialCategory,
                                                                 String billOfMaterialVariant,
                                                                 String billOfMaterialVersion,
                                                                 String bOMVersionStatus,
                                                                 Boolean isLatestBOMVersion)

Description copied from interface: BillOfMaterialsService

Creates a fluent helper for the ReleaseVersionBOM OData function import.

Specified by:

releaseVersionBOM in interface BillOfMaterialsService

Parameters:

billOfMaterialHeaderUUID - ID hdr chge status

Constraints: none

Original parameter name from the Odata EDM: BillOfMaterialHeaderUUID

billOfMaterial - Bill of Material

Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: BillOfMaterial

billOfMaterialCategory - BOM category

Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: BillOfMaterialCategory

billOfMaterialVariant - Alternative BOM

Constraints: Not nullable, Maximum length: 2

Original parameter name from the Odata EDM: BillOfMaterialVariant

billOfMaterialVersion - BOM Version

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: BillOfMaterialVersion

bOMVersionStatus - BOM Version Status

Constraints: Not nullable, Maximum length: 2

Original parameter name from the Odata EDM: BOMVersionStatus

isLatestBOMVersion - Latest Version

Constraints: none

Original parameter name from the Odata EDM: IsLatestBOMVersion

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.