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

Interface BillOfMaterialsService

All Superinterfaces:
BatchService<BillOfMaterialsServiceBatch>
All Known Implementing Classes:
DefaultBillOfMaterialsService
@Deprecated public interface BillOfMaterialsService extends BatchService<BillOfMaterialsServiceBatch>
Deprecated.
The service and all its related classes are deprecated as of release 2105 (May 2021). Please use the odata generator to generate the VDM.

The service enables you to read, create, and update bills of material with and without version. The service 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 none or more items for each header. .

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: API_BILL_OF_MATERIAL_SRV
API Version: 1.0.0
Minimum ERP Version: 2208
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), Make-to-Order Production - Finished Goods Sales and Final Assembly(BJE), Change Manufacturing Bill of Material for Production(3LO), Mass Change Manufacturing Bill of Material for Production(3LP)
Business Object: Bill Of Material

  • Field Details

  • Method Details

    • withServicePath

      @Nonnull BillOfMaterialsService 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.

    • getAllBillOfMaterial

      @Nonnull BillOfMaterialFluentHelper getAllBillOfMaterial()
      Deprecated.
      Fetch multiple BillOfMaterial entities.
      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 BillOfMaterialByKeyFluentHelper getBillOfMaterialByKey(UUID billOfMaterialHeaderUUID)
      Deprecated.
      Fetch a single BillOfMaterial entity using key fields.
      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 BillOfMaterialCreateFluentHelper createBillOfMaterial(@Nonnull BillOfMaterial billOfMaterial)
      Deprecated.
      Create a new BillOfMaterial entity and save it to the S/4HANA system.
      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 BillOfMaterialUpdateFluentHelper updateBillOfMaterial(@Nonnull BillOfMaterial billOfMaterial)
      Deprecated.
      Update an existing BillOfMaterial entity and save it to the S/4HANA system.
      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 BillOfMaterialItemFluentHelper getAllBillOfMaterialItem()
      Deprecated.
      Fetch multiple BillOfMaterialItem entities.
      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 BillOfMaterialItemByKeyFluentHelper getBillOfMaterialItemByKey(UUID billOfMaterialItemUUID)
      Deprecated.
      Fetch a single BillOfMaterialItem entity using key fields.
      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 BillOfMaterialItemCreateFluentHelper createBillOfMaterialItem(@Nonnull BillOfMaterialItem billOfMaterialItem)
      Deprecated.
      Create a new BillOfMaterialItem entity and save it to the S/4HANA system.
      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 BillOfMaterialItemUpdateFluentHelper updateBillOfMaterialItem(@Nonnull BillOfMaterialItem billOfMaterialItem)
      Deprecated.
      Update an existing BillOfMaterialItem entity and save it to the S/4HANA system.
      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 BillOfMaterialUsageFluentHelper getAllBillOfMaterialUsage()
      Deprecated.
      Fetch multiple BillOfMaterialUsage entities.
      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 BillOfMaterialUsageByKeyFluentHelper getBillOfMaterialUsageByKey(String billOfMaterialVariantUsage)
      Deprecated.
      Fetch a single BillOfMaterialUsage entity using key fields.
      Parameters:
      billOfMaterialVariantUsage - BOM Usage

      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 BillOfMaterialUsageTextFluentHelper getAllBillOfMaterialUsageText()
      Deprecated.
      Fetch multiple BillOfMaterialUsageText entities.
      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 BillOfMaterialUsageTextByKeyFluentHelper getBillOfMaterialUsageTextByKey(String language, String billOfMaterialVariantUsage)
      Deprecated.
      Fetch a single BillOfMaterialUsageText entity using key fields.
      Parameters:
      language - Language Key

      Constraints: Not nullable, Maximum length: 2

      billOfMaterialVariantUsage - BOM Usage

      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 BOMItemCategoryFluentHelper getAllBOMItemCategory()
      Deprecated.
      Fetch multiple BOMItemCategory entities.
      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 BOMItemCategoryByKeyFluentHelper getBOMItemCategoryByKey(String billOfMaterialItemCategory)
      Deprecated.
      Fetch a single BOMItemCategory entity using key fields.
      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 BOMItemCategoryTextFluentHelper getAllBOMItemCategoryText()
      Deprecated.
      Fetch multiple BOMItemCategoryText entities.
      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 BOMItemCategoryTextByKeyFluentHelper getBOMItemCategoryTextByKey(String language, String billOfMaterialItemCategory)
      Deprecated.
      Fetch a single BOMItemCategoryText entity using key fields.
      Parameters:
      billOfMaterialItemCategory - Item category (bill of material)

      Constraints: Not nullable, Maximum length: 1

      language - Language Key

      Constraints: Not nullable, Maximum length: 2

      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 ExplodeBOMFluentHelper explodeBOM(@Nonnull UUID billOfMaterialHeaderUUID, @Nullable String material, @Nullable String plant, @Nullable String billOfMaterialVariant, @Nullable String bOMExplosionApplication, @Nullable BigDecimal requiredQuantity, @Nullable String engineeringChangeDocument, @Nullable Boolean bOMExplosionIsLimited, @Nullable String bOMItmQtyIsScrapRelevant, @Nullable String billOfMaterialItemCategory, @Nullable String bOMExplosionAssembly, @Nullable LocalDateTime bOMExplosionDate, @Nullable BigDecimal bOMExplosionLevel, @Nullable Boolean bOMExplosionIsMultilevel, @Nullable String materialProvisionFltrType, @Nullable String sparePartFltrType)
      Deprecated.

      Creates a fluent helper for the ExplodeBOM OData function import.

      Parameters:
      bOMItmQtyIsScrapRelevant - Exceptions

      Constraints: Nullable, Maximum length: 1

      Original parameter name from the Odata EDM: BOMItmQtyIsScrapRelevant

      sparePartFltrType - Spare Part Indicator

      Constraints: Nullable, Maximum length: 1

      Original parameter name from the Odata EDM: SparePartFltrType

      bOMExplosionLevel - Explosion level

      Constraints: Nullable, Precision: 3, Scale: 0

      Original parameter name from the Odata EDM: BOMExplosionLevel

      bOMExplosionIsLimited - Limited Explosion

      Constraints: Nullable

      Original parameter name from the Odata EDM: BOMExplosionIsLimited

      bOMExplosionApplication - BOM Application

      Constraints: Nullable, Maximum length: 4

      Original parameter name from the Odata EDM: BOMExplosionApplication

      requiredQuantity - Base quantity

      Constraints: Nullable, Precision: 13, Scale: 3

      Original parameter name from the Odata EDM: RequiredQuantity

      material - Material

      Constraints: Nullable, Maximum length: 40

      Original parameter name from the Odata EDM: Material

      billOfMaterialHeaderUUID - ID hdr chge status

      Constraints: none

      Original parameter name from the Odata EDM: BillOfMaterialHeaderUUID

      plant - Plant

      Constraints: Nullable, Maximum length: 4

      Original parameter name from the Odata EDM: Plant

      engineeringChangeDocument - Change Number

      Constraints: Nullable, Maximum length: 12

      Original parameter name from the Odata EDM: EngineeringChangeDocument

      billOfMaterialItemCategory - Item Category

      Constraints: Nullable, Maximum length: 1

      Original parameter name from the Odata EDM: BillOfMaterialItemCategory

      bOMExplosionIsMultilevel - Multi-lev.

      Constraints: Nullable

      Original parameter name from the Odata EDM: BOMExplosionIsMultilevel

      billOfMaterialVariant - Alternative BOM

      Constraints: Nullable, Maximum length: 2

      Original parameter name from the Odata EDM: BillOfMaterialVariant

      materialProvisionFltrType - Mat. Provision Ind.

      Constraints: Nullable, Maximum length: 1

      Original parameter name from the Odata EDM: MaterialProvisionFltrType

      bOMExplosionAssembly - Material

      Constraints: Nullable, Maximum length: 40

      Original parameter name from the Odata EDM: BOMExplosionAssembly

      bOMExplosionDate - Valid From

      Constraints: Nullable, Precision: 0

      Original parameter name from the Odata EDM: BOMExplosionDate

      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 ReleaseVersionBOMFluentHelper releaseVersionBOM(@Nonnull UUID billOfMaterialHeaderUUID, @Nullable String stlnr, @Nullable String stlty, @Nullable String stlal, @Nullable String bomVersn, @Nullable String versnst, @Nullable Boolean versnlastind)
      Deprecated.

      Creates a fluent helper for the ReleaseVersionBOM OData function import.

      Parameters:
      stlnr - Bill of Material

      Constraints: Nullable, Maximum length: 8

      Original parameter name from the Odata EDM: Stlnr

      billOfMaterialHeaderUUID - ID hdr chge status

      Constraints: none

      Original parameter name from the Odata EDM: BillOfMaterialHeaderUUID

      versnlastind - Latest Rel Version

      Constraints: Nullable

      Original parameter name from the Odata EDM: Versnlastind

      stlty - BOM category

      Constraints: Nullable, Maximum length: 1

      Original parameter name from the Odata EDM: Stlty

      versnst - BOM Version Status

      Constraints: Nullable, Maximum length: 2

      Original parameter name from the Odata EDM: Versnst

      stlal - Alternative BOM

      Constraints: Nullable, Maximum length: 2

      Original parameter name from the Odata EDM: Stlal

      bomVersn - BOM Version

      Constraints: Nullable, Maximum length: 4

      Original parameter name from the Odata EDM: BomVersn

      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.