DefaultBillOfMaterialsService (SAP S/4HANA Cloud SDK

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 enables you to read, create and update Bills of Material and Version Bills of Material. It is based on the OData protocol and can be consumed in SAP Fiori apps and on other user interfaces. The service contains either no header, one header or multiple headers for the specified material and zero or more items for each header. .

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 - Versions Management (1NR), Engineering Bill of Material - Change Master Management (1R3)
Authentication Methods:	Basic, x509

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.

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

Method Summary

All Methods Instance Methods Concrete Methods
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.
`ExplodeBOMFluentHelper`	`explodeBOM(UUID billOfMaterialHeaderUUID, String material, String plant, String billOfMaterialVariant, String bOMExplosionApplication, BigDecimal requiredQuantity, String engineeringChangeDocument, Boolean bOMExplosionIsLimited, String bOMItmQtyIsScrapRelevant, String billOfMaterialItemCategory, String bOMExplosionAssembly, LocalDateTime bOMExplosionDate, BigDecimal bOMExplosionLevel, Boolean bOMExplosionIsMultilevel, String materialProvisionFltrType, String sparePartFltrType)` Creates a fluent helper for the ExplodeBOM OData function import.
`BillOfMaterialFluentHelper`	`getAllBillOfMaterial()` Fetch multiple `BillOfMaterial` entities.
`BillOfMaterialItemFluentHelper`	`getAllBillOfMaterialItem()` Fetch multiple `BillOfMaterialItem` entities.
`BillOfMaterialUsageFluentHelper`	`getAllBillOfMaterialUsage()` Fetch multiple `BillOfMaterialUsage` entities.
`BillOfMaterialUsageTextFluentHelper`	`getAllBillOfMaterialUsageText()` Fetch multiple `BillOfMaterialUsageText` entities.
`BOMItemCategoryFluentHelper`	`getAllBOMItemCategory()` Fetch multiple `BOMItemCategory` entities.
`BOMItemCategoryTextFluentHelper`	`getAllBOMItemCategoryText()` Fetch multiple `BOMItemCategoryText` 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.
`BillOfMaterialUsageByKeyFluentHelper`	`getBillOfMaterialUsageByKey(String billOfMaterialVariantUsage)` Fetch a single `BillOfMaterialUsage` entity using key fields.
`BillOfMaterialUsageTextByKeyFluentHelper`	`getBillOfMaterialUsageTextByKey(String language, String billOfMaterialVariantUsage)` Fetch a single `BillOfMaterialUsageText` entity using key fields.
`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.
`ReleaseVersionBOMFluentHelper`	`releaseVersionBOM(UUID billOfMaterialHeaderUUID, String stlnr, String stlty, String stlal, String bomVersn, String versnst, Boolean versnlastind)` 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.
  - getAllBillOfMaterialUsage
```
@Nonnull
public BillOfMaterialUsageFluentHelper getAllBillOfMaterialUsage()
```
    Description copied from interface: BillOfMaterialsService
    
    Fetch multiple BillOfMaterialUsage entities.
    
    Specified by:
    
    getAllBillOfMaterialUsage in interface BillOfMaterialsService
    
    Returns:
    
    A fluent helper to fetch multiple BillOfMaterialUsage 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.
  - getBillOfMaterialUsageByKey
```
@Nonnull
public BillOfMaterialUsageByKeyFluentHelper getBillOfMaterialUsageByKey(String billOfMaterialVariantUsage)
```
    Description copied from interface: BillOfMaterialsService
    
    Fetch a single BillOfMaterialUsage entity using key fields.
    
    Specified by:
    
    getBillOfMaterialUsageByKey in interface BillOfMaterialsService
    
    Parameters:
    
    billOfMaterialVariantUsage - This key defines the area (such as engineering/design or production) where a BOM can be used.
    Constraints: Not nullable, Maximum length: 1
    
    Returns:
    
    A fluent helper to fetch a single BillOfMaterialUsage 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.
  - getAllBillOfMaterialUsageText
```
@Nonnull
public BillOfMaterialUsageTextFluentHelper getAllBillOfMaterialUsageText()
```
    Description copied from interface: BillOfMaterialsService
    
    Fetch multiple BillOfMaterialUsageText entities.
    
    Specified by:
    
    getAllBillOfMaterialUsageText in interface BillOfMaterialsService
    
    Returns:
    
    A fluent helper to fetch multiple BillOfMaterialUsageText 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.
  - getBillOfMaterialUsageTextByKey
```
@Nonnull
public BillOfMaterialUsageTextByKeyFluentHelper getBillOfMaterialUsageTextByKey(String language,
                                                                                         String billOfMaterialVariantUsage)
```
    Description copied from interface: BillOfMaterialsService
    
    Fetch a single BillOfMaterialUsageText entity using key fields.
    
    Specified by:
    
    getBillOfMaterialUsageTextByKey in interface BillOfMaterialsService
    
    Parameters:
    
    language - The language key indicates
    Constraints: Not nullable, Maximum length: 2
    
    billOfMaterialVariantUsage - This key defines the area (such as engineering/design or production) where a BOM can be used.
    Constraints: Not nullable, Maximum length: 1
    
    Returns:
    
    A fluent helper to fetch a single BillOfMaterialUsageText 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.
  - getAllBOMItemCategory
```
@Nonnull
public BOMItemCategoryFluentHelper getAllBOMItemCategory()
```
    Description copied from interface: BillOfMaterialsService
    
    Fetch multiple BOMItemCategory entities.
    
    Specified by:
    
    getAllBOMItemCategory in interface BillOfMaterialsService
    
    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: BillOfMaterialsService
    
    Fetch a single BOMItemCategory entity using key fields.
    
    Specified by:
    
    getBOMItemCategoryByKey in interface BillOfMaterialsService
    
    Parameters:
    
    billOfMaterialItemCategory - Categorization of the items in a BOM according to set criteria, such as whether they refer to an object (for example, material master or document info record) or whether they are kept in stock.
    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: BillOfMaterialsService
    
    Fetch multiple BOMItemCategoryText entities.
    
    Specified by:
    
    getAllBOMItemCategoryText in interface BillOfMaterialsService
    
    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: BillOfMaterialsService
    
    Fetch a single BOMItemCategoryText entity using key fields.
    
    Specified by:
    
    getBOMItemCategoryTextByKey in interface BillOfMaterialsService
    
    Parameters:
    
    language - The language key indicates
    Constraints: Not nullable, Maximum length: 2
    
    billOfMaterialItemCategory - Categorization of the items in a BOM according to set criteria, such as whether they refer to an object (for example, material master or document info record) or whether they are kept in stock.
    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.
  - explodeBOM
```
@Nonnull
public ExplodeBOMFluentHelper explodeBOM(UUID billOfMaterialHeaderUUID,
                                                  String material,
                                                  String plant,
                                                  String billOfMaterialVariant,
                                                  String bOMExplosionApplication,
                                                  BigDecimal requiredQuantity,
                                                  String engineeringChangeDocument,
                                                  Boolean bOMExplosionIsLimited,
                                                  String bOMItmQtyIsScrapRelevant,
                                                  String billOfMaterialItemCategory,
                                                  String bOMExplosionAssembly,
                                                  LocalDateTime bOMExplosionDate,
                                                  BigDecimal bOMExplosionLevel,
                                                  Boolean bOMExplosionIsMultilevel,
                                                  String materialProvisionFltrType,
                                                  String sparePartFltrType)
```
    Description copied from interface: BillOfMaterialsService
    
    Creates a fluent helper for the ExplodeBOM OData function import.
    
    Specified by:
    
    explodeBOM in interface BillOfMaterialsService
    
    Parameters:
    
    billOfMaterialHeaderUUID - ID hdr chge status
    
    Constraints: none
    
    Original parameter name from the Odata EDM: BillOfMaterialHeaderUUID
    
    material - Material
    
    Constraints: Not nullable, Maximum length: 40
    
    Original parameter name from the Odata EDM: Material
    
    plant - Plant
    
    Constraints: Not nullable, Maximum length: 4
    
    Original parameter name from the Odata EDM: Plant
    
    billOfMaterialVariant - Alternative BOM
    
    Constraints: Not nullable, Maximum length: 2
    
    Original parameter name from the Odata EDM: BillOfMaterialVariant
    
    bOMExplosionApplication - BOM Application
    
    Constraints: Not nullable, Maximum length: 4
    
    Original parameter name from the Odata EDM: BOMExplosionApplication
    
    requiredQuantity - Base quantity
    
    Constraints: Not nullable, Precision: 13, Scale: 3
    
    Original parameter name from the Odata EDM: RequiredQuantity
    
    engineeringChangeDocument - Change Number
    
    Constraints: Not nullable, Maximum length: 12
    
    Original parameter name from the Odata EDM: EngineeringChangeDocument
    
    bOMExplosionIsLimited - Limited Explosion
    
    Constraints: none
    
    Original parameter name from the Odata EDM: BOMExplosionIsLimited
    
    bOMItmQtyIsScrapRelevant - Exceptions
    
    Constraints: Not nullable, Maximum length: 1
    
    Original parameter name from the Odata EDM: BOMItmQtyIsScrapRelevant
    
    billOfMaterialItemCategory - Item category
    
    Constraints: Not nullable, Maximum length: 1
    
    Original parameter name from the Odata EDM: BillOfMaterialItemCategory
    
    bOMExplosionAssembly - Material
    
    Constraints: Not nullable, Maximum length: 40
    
    Original parameter name from the Odata EDM: BOMExplosionAssembly
    
    bOMExplosionDate - Valid From
    
    Constraints: Not nullable, Precision: 0
    
    Original parameter name from the Odata EDM: BOMExplosionDate
    
    bOMExplosionLevel - Explosion level
    
    Constraints: Not nullable, Precision: 3, Scale: 0
    
    Original parameter name from the Odata EDM: BOMExplosionLevel
    
    bOMExplosionIsMultilevel - Multi-lev.
    
    Constraints: none
    
    Original parameter name from the Odata EDM: BOMExplosionIsMultilevel
    
    materialProvisionFltrType - Mat. Provision Ind.
    
    Constraints: Not nullable, Maximum length: 1
    
    Original parameter name from the Odata EDM: MaterialProvisionFltrType
    
    sparePartFltrType - Spare Part Indicator
    
    Constraints: Not nullable, Maximum length: 1
    
    Original parameter name from the Odata EDM: SparePartFltrType
    
    Returns:
    
    A fluent helper object that will execute the ExplodeBOM OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - releaseVersionBOM
```
@Nonnull
public ReleaseVersionBOMFluentHelper releaseVersionBOM(UUID billOfMaterialHeaderUUID,
                                                                String stlnr,
                                                                String stlty,
                                                                String stlal,
                                                                String bomVersn,
                                                                String versnst,
                                                                Boolean versnlastind)
```
    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
    
    stlnr - Bill of Material
    
    Constraints: Not nullable, Maximum length: 8
    
    Original parameter name from the Odata EDM: Stlnr
    
    stlty - BOM category
    
    Constraints: Not nullable, Maximum length: 1
    
    Original parameter name from the Odata EDM: Stlty
    
    stlal - Alternative BOM
    
    Constraints: Not nullable, Maximum length: 2
    
    Original parameter name from the Odata EDM: Stlal
    
    bomVersn - BOM Version
    
    Constraints: Not nullable, Maximum length: 4
    
    Original parameter name from the Odata EDM: BomVersn
    
    versnst - BOM Version Status
    
    Constraints: Not nullable, Maximum length: 2
    
    Original parameter name from the Odata EDM: Versnst
    
    versnlastind - Latest Version
    
    Constraints: none
    
    Original parameter name from the Odata EDM: Versnlastind
    
    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.

Class DefaultBillOfMaterialsService

Details:

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultBillOfMaterialsService

Method Detail

withServicePath

getAllBillOfMaterial

getBillOfMaterialByKey

createBillOfMaterial

updateBillOfMaterial

getAllBillOfMaterialItem

getBillOfMaterialItemByKey

createBillOfMaterialItem

updateBillOfMaterialItem

getAllBillOfMaterialUsage

getBillOfMaterialUsageByKey

getAllBillOfMaterialUsageText

getBillOfMaterialUsageTextByKey

getAllBOMItemCategory

getBOMItemCategoryByKey

getAllBOMItemCategoryText

getBOMItemCategoryTextByKey

explodeBOM

releaseVersionBOM