Package 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:
BatchService<BillOfMaterialsServiceBatch>, BillOfMaterialsService
@Named("com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultBillOfMaterialsService") @Deprecated public class DefaultBillOfMaterialsService extends Object implements BillOfMaterialsService
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

  • Constructor Details

  • Method Details

    • withServicePath

      @Nonnull public DefaultBillOfMaterialsService withServicePath(@Nonnull String servicePath)
      Deprecated.
      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.

    • batch

      @Nonnull public DefaultBillOfMaterialsServiceBatch batch()
      Deprecated.
      Specified by:
      batch in interface BatchService<BillOfMaterialsServiceBatch>

    • getAllBillOfMaterial

      @Nonnull public BillOfMaterialFluentHelper getAllBillOfMaterial()
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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()
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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()
      Deprecated.
      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)
      Deprecated.
      Description copied from interface: BillOfMaterialsService
      Fetch a single BillOfMaterialUsage entity using key fields.
      Specified by:
      getBillOfMaterialUsageByKey in interface BillOfMaterialsService
      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 public BillOfMaterialUsageTextFluentHelper getAllBillOfMaterialUsageText()
      Deprecated.
      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)
      Deprecated.
      Description copied from interface: BillOfMaterialsService
      Fetch a single BillOfMaterialUsageText entity using key fields.
      Specified by:
      getBillOfMaterialUsageTextByKey in interface BillOfMaterialsService
      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 public BOMItemCategoryFluentHelper getAllBOMItemCategory()
      Deprecated.
      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)
      Deprecated.
      Description copied from interface: BillOfMaterialsService
      Fetch a single BOMItemCategory entity using key fields.
      Specified by:
      getBOMItemCategoryByKey in interface BillOfMaterialsService
      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 public BOMItemCategoryTextFluentHelper getAllBOMItemCategoryText()
      Deprecated.
      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)
      Deprecated.
      Description copied from interface: BillOfMaterialsService
      Fetch a single BOMItemCategoryText entity using key fields.
      Specified by:
      getBOMItemCategoryTextByKey in interface BillOfMaterialsService
      Parameters:
      language - Language Key

      Constraints: Not nullable, Maximum length: 2

      billOfMaterialItemCategory - Item category (bill of material)

      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(@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.
      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: Nullable, Maximum length: 40

      Original parameter name from the Odata EDM: Material

      plant - Plant

      Constraints: Nullable, Maximum length: 4

      Original parameter name from the Odata EDM: Plant

      billOfMaterialVariant - Alternative BOM

      Constraints: Nullable, Maximum length: 2

      Original parameter name from the Odata EDM: BillOfMaterialVariant

      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

      engineeringChangeDocument - Change Number

      Constraints: Nullable, Maximum length: 12

      Original parameter name from the Odata EDM: EngineeringChangeDocument

      bOMExplosionIsLimited - Limited Explosion

      Constraints: Nullable

      Original parameter name from the Odata EDM: BOMExplosionIsLimited

      bOMItmQtyIsScrapRelevant - Exceptions

      Constraints: Nullable, Maximum length: 1

      Original parameter name from the Odata EDM: BOMItmQtyIsScrapRelevant

      billOfMaterialItemCategory - Item Category

      Constraints: Nullable, Maximum length: 1

      Original parameter name from the Odata EDM: BillOfMaterialItemCategory

      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

      bOMExplosionLevel - Explosion level

      Constraints: Nullable, Precision: 3, Scale: 0

      Original parameter name from the Odata EDM: BOMExplosionLevel

      bOMExplosionIsMultilevel - Multi-lev.

      Constraints: Nullable

      Original parameter name from the Odata EDM: BOMExplosionIsMultilevel

      materialProvisionFltrType - Mat. Provision Ind.

      Constraints: Nullable, Maximum length: 1

      Original parameter name from the Odata EDM: MaterialProvisionFltrType

      sparePartFltrType - Spare Part Indicator

      Constraints: 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(@Nonnull UUID billOfMaterialHeaderUUID, @Nullable String stlnr, @Nullable String stlty, @Nullable String stlal, @Nullable String bomVersn, @Nullable String versnst, @Nullable Boolean versnlastind)
      Deprecated.
      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: Nullable, Maximum length: 8

      Original parameter name from the Odata EDM: Stlnr

      stlty - BOM category

      Constraints: Nullable, Maximum length: 1

      Original parameter name from the Odata EDM: Stlty

      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

      versnst - BOM Version Status

      Constraints: Nullable, Maximum length: 2

      Original parameter name from the Odata EDM: Versnst

      versnlastind - Latest Rel Version

      Constraints: Nullable

      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.