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

Interface OrderBillOfMaterialService

All Superinterfaces:
BatchService<OrderBillOfMaterialServiceBatch>
All Known Implementing Classes:
DefaultOrderBillOfMaterialService
@Deprecated public interface OrderBillOfMaterialService extends BatchService<OrderBillOfMaterialServiceBatch>
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

The service contains either no header, one header, or multiple headers for the specified order bill of material and zero or more items for each header. The required information is sent in the request as a payload to create, update, or delete order bill of material and items, make appropriate checks for restricted values. If there are any issues when the order bill of material is created, updated, or deleted, the system displays error messages in the response..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: API_ORDER_BILL_OF_MATERIAL_SRV
API Version: 1.1.0
Minimum ERP Version: 2302
Communication Scenario: Product Lifecycle Management - Master Data Integration(SAP_COM_0105)
Scope Items: Make-to-Order Production - Finished Goods Sales and Final Assembly(BJE), Engineering Bill of Material - Versions Management(1NR), Engineering Bill of Material - Change Master Management(1R3), Change Manufacturing Bill of Material for Production(3LO), Mass Change Manufacturing Bill of Material for Production(3LP)
Authentication Methods: x509
Business Object: Sales Bill Of Material

  • Field Details

  • Method Details

    • withServicePath

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

    • 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.

    • getAllSalesOrderBOMItem

      @Nonnull SalesOrderBOMItemFluentHelper getAllSalesOrderBOMItem()
      Deprecated.
      Fetch multiple SalesOrderBOMItem entities.
      Returns:
      A fluent helper to fetch multiple SalesOrderBOMItem 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.

    • getSalesOrderBOMItemByKey

      @Nonnull SalesOrderBOMItemByKeyFluentHelper getSalesOrderBOMItemByKey(String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialItemNodeNumber, String headerChangeDocument, String material, String plant)
      Deprecated.
      Fetch a single SalesOrderBOMItem entity using key fields.
      Parameters:
      headerChangeDocument - Change Number

      Constraints: Not nullable, Maximum length: 12

      material - Material Number

      Constraints: Not nullable, Maximum length: 40

      billOfMaterialCategory - BOM category

      Constraints: Not nullable, Maximum length: 1

      plant - Plant

      Constraints: Not nullable, Maximum length: 4

      billOfMaterial - Bill of Material

      Constraints: Not nullable, Maximum length: 8

      billOfMaterialVariant - Alternative BOM

      Constraints: Not nullable, Maximum length: 2

      billOfMaterialItemNodeNumber - BOM item node number

      Constraints: Not nullable, Maximum length: 8

      Returns:
      A fluent helper to fetch a single SalesOrderBOMItem 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.

    • createSalesOrderBOMItem

      @Nonnull SalesOrderBOMItemCreateFluentHelper createSalesOrderBOMItem(@Nonnull SalesOrderBOMItem salesOrderBOMItem)
      Deprecated.
      Create a new SalesOrderBOMItem entity and save it to the S/4HANA system.
      Parameters:
      salesOrderBOMItem - SalesOrderBOMItem entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new SalesOrderBOMItem entity. To perform execution, call the execute method on the fluent helper object.

    • updateSalesOrderBOMItem

      @Nonnull SalesOrderBOMItemUpdateFluentHelper updateSalesOrderBOMItem(@Nonnull SalesOrderBOMItem salesOrderBOMItem)
      Deprecated.
      Update an existing SalesOrderBOMItem entity and save it to the S/4HANA system.
      Parameters:
      salesOrderBOMItem - SalesOrderBOMItem entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing SalesOrderBOMItem entity. To perform execution, call the execute method on the fluent helper object.

    • deleteSalesOrderBOMItem

      @Nonnull SalesOrderBOMItemDeleteFluentHelper deleteSalesOrderBOMItem(@Nonnull SalesOrderBOMItem salesOrderBOMItem)
      Deprecated.
      Deletes an existing SalesOrderBOMItem entity in the S/4HANA system.
      Parameters:
      salesOrderBOMItem - SalesOrderBOMItem entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing SalesOrderBOMItem entity. To perform execution, call the execute method on the fluent helper object.

    • getAllSalesOrderBOM

      @Nonnull SalesOrderBOMFluentHelper getAllSalesOrderBOM()
      Deprecated.
      Fetch multiple SalesOrderBOM entities.
      Returns:
      A fluent helper to fetch multiple SalesOrderBOM 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.

    • getSalesOrderBOMByKey

      @Nonnull SalesOrderBOMByKeyFluentHelper getSalesOrderBOMByKey(String billOfMaterialCategory, String billOfMaterial, String billOfMaterialVariant, String engineeringChangeDocument, String material, String plant)
      Deprecated.
      Fetch a single SalesOrderBOM entity using key fields.
      Parameters:
      material - Material Number

      Constraints: Not nullable, Maximum length: 40

      billOfMaterialCategory - BOM category

      Constraints: Not nullable, Maximum length: 1

      engineeringChangeDocument - Change Number

      Constraints: Not nullable, Maximum length: 12

      plant - Plant

      Constraints: Not nullable, Maximum length: 4

      billOfMaterial - Bill of Material

      Constraints: Not nullable, Maximum length: 8

      billOfMaterialVariant - Alternative BOM

      Constraints: Not nullable, Maximum length: 2

      Returns:
      A fluent helper to fetch a single SalesOrderBOM 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.

    • createSalesOrderBOM

      @Nonnull SalesOrderBOMCreateFluentHelper createSalesOrderBOM(@Nonnull SalesOrderBOM salesOrderBOM)
      Deprecated.
      Create a new SalesOrderBOM entity and save it to the S/4HANA system.
      Parameters:
      salesOrderBOM - SalesOrderBOM entity object that will be created in the S/4HANA system.
      Returns:
      A fluent helper to create a new SalesOrderBOM entity. To perform execution, call the execute method on the fluent helper object.

    • updateSalesOrderBOM

      @Nonnull SalesOrderBOMUpdateFluentHelper updateSalesOrderBOM(@Nonnull SalesOrderBOM salesOrderBOM)
      Deprecated.
      Update an existing SalesOrderBOM entity and save it to the S/4HANA system.
      Parameters:
      salesOrderBOM - SalesOrderBOM entity object that will be updated in the S/4HANA system.
      Returns:
      A fluent helper to update an existing SalesOrderBOM entity. To perform execution, call the execute method on the fluent helper object.

    • deleteSalesOrderBOM

      @Nonnull SalesOrderBOMDeleteFluentHelper deleteSalesOrderBOM(@Nonnull SalesOrderBOM salesOrderBOM)
      Deprecated.
      Deletes an existing SalesOrderBOM entity in the S/4HANA system.
      Parameters:
      salesOrderBOM - SalesOrderBOM entity object that will be deleted in the S/4HANA system.
      Returns:
      A fluent helper to delete an existing SalesOrderBOM entity. To perform execution, call the execute method on the fluent helper object.

    • deleteBOMItemWithChangeNumber

      @Nonnull DeleteBOMItemWithChangeNumberFluentHelper deleteBOMItemWithChangeNumber(@Nonnull String billOfMaterial, @Nonnull String billOfMaterialCategory, @Nonnull String billOfMaterialVariant, @Nonnull String billOfMaterialItemNodeNumber, @Nonnull String headerChangeDocument, @Nonnull String material, @Nonnull String plant, @Nullable String engineeringChangeDocForEdit)
      Deprecated.

      Creates a fluent helper for the DeleteBOMItemWithChangeNumber OData function import.

      Parameters:
      headerChangeDocument - Change Number

      Constraints: Not nullable, Maximum length: 12

      Original parameter name from the Odata EDM: HeaderChangeDocument

      material - Material

      Constraints: Not nullable, Maximum length: 40

      Original parameter name from the Odata EDM: Material

      billOfMaterialCategory - BOM category

      Constraints: Not nullable, Maximum length: 1

      Original parameter name from the Odata EDM: BillOfMaterialCategory

      engineeringChangeDocForEdit - Change Number

      Constraints: Nullable, Maximum length: 12

      Original parameter name from the Odata EDM: EngineeringChangeDocForEdit

      plant - Plant

      Constraints: Not nullable, Maximum length: 4

      Original parameter name from the Odata EDM: Plant

      billOfMaterial - Bill of Material

      Constraints: Not nullable, Maximum length: 8

      Original parameter name from the Odata EDM: BillOfMaterial

      billOfMaterialVariant - Alternative BOM

      Constraints: Not nullable, Maximum length: 2

      Original parameter name from the Odata EDM: BillOfMaterialVariant

      billOfMaterialItemNodeNumber - Item node

      Constraints: Not nullable, Maximum length: 8

      Original parameter name from the Odata EDM: BillOfMaterialItemNodeNumber

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

    • deleteBOMHdrWithChangeNumber

      @Nonnull DeleteBOMHdrWithChangeNumberFluentHelper deleteBOMHdrWithChangeNumber(@Nonnull String billOfMaterialCategory, @Nonnull String billOfMaterial, @Nonnull String billOfMaterialVariant, @Nonnull String engineeringChangeDocument, @Nonnull String material, @Nonnull String plant, @Nullable String engineeringChangeDocForEdit)
      Deprecated.

      Creates a fluent helper for the DeleteBOMHdrWithChangeNumber OData function import.

      Parameters:
      material - Material

      Constraints: Not nullable, Maximum length: 40

      Original parameter name from the Odata EDM: Material

      billOfMaterialCategory - BOM category

      Constraints: Not nullable, Maximum length: 1

      Original parameter name from the Odata EDM: BillOfMaterialCategory

      engineeringChangeDocForEdit - Change Number

      Constraints: Nullable, Maximum length: 12

      Original parameter name from the Odata EDM: EngineeringChangeDocForEdit

      engineeringChangeDocument - Change Number

      Constraints: Not nullable, Maximum length: 12

      Original parameter name from the Odata EDM: EngineeringChangeDocument

      plant - Plant

      Constraints: Not nullable, Maximum length: 4

      Original parameter name from the Odata EDM: Plant

      billOfMaterial - Bill of Material

      Constraints: Not nullable, Maximum length: 8

      Original parameter name from the Odata EDM: BillOfMaterial

      billOfMaterialVariant - Alternative BOM

      Constraints: Not nullable, Maximum length: 2

      Original parameter name from the Odata EDM: BillOfMaterialVariant

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