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

Class DefaultOrderBillOfMaterialService

java.lang.Object
com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultOrderBillOfMaterialService
All Implemented Interfaces:
BatchService<OrderBillOfMaterialServiceBatch>, OrderBillOfMaterialService
@Named("com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultOrderBillOfMaterialService") @Deprecated public class DefaultOrderBillOfMaterialService extends Object implements OrderBillOfMaterialService
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

  • Constructor Details

  • Method Details

    • withServicePath

      @Nonnull public DefaultOrderBillOfMaterialService withServicePath(@Nonnull String servicePath)
      Deprecated.
      Description copied from interface: OrderBillOfMaterialService
      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 OrderBillOfMaterialService
      Parameters:
      servicePath - Service path that will override the default.
      Returns:
      A new service instance with the specified service path.

    • batch

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

    • getAllBOMItemCategory

      @Nonnull public BOMItemCategoryFluentHelper getAllBOMItemCategory()
      Deprecated.
      Description copied from interface: OrderBillOfMaterialService
      Fetch multiple BOMItemCategory entities.
      Specified by:
      getAllBOMItemCategory in interface OrderBillOfMaterialService
      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: OrderBillOfMaterialService
      Fetch a single BOMItemCategory entity using key fields.
      Specified by:
      getBOMItemCategoryByKey in interface OrderBillOfMaterialService
      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: OrderBillOfMaterialService
      Fetch multiple BOMItemCategoryText entities.
      Specified by:
      getAllBOMItemCategoryText in interface OrderBillOfMaterialService
      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: OrderBillOfMaterialService
      Fetch a single BOMItemCategoryText entity using key fields.
      Specified by:
      getBOMItemCategoryTextByKey in interface OrderBillOfMaterialService
      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.

    • getAllSalesOrderBOMItem

      @Nonnull public SalesOrderBOMItemFluentHelper getAllSalesOrderBOMItem()
      Deprecated.
      Description copied from interface: OrderBillOfMaterialService
      Fetch multiple SalesOrderBOMItem entities.
      Specified by:
      getAllSalesOrderBOMItem in interface OrderBillOfMaterialService
      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 public SalesOrderBOMItemByKeyFluentHelper getSalesOrderBOMItemByKey(String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialItemNodeNumber, String headerChangeDocument, String material, String plant)
      Deprecated.
      Description copied from interface: OrderBillOfMaterialService
      Fetch a single SalesOrderBOMItem entity using key fields.
      Specified by:
      getSalesOrderBOMItemByKey in interface OrderBillOfMaterialService
      Parameters:
      billOfMaterial - Bill of Material

      Constraints: Not nullable, Maximum length: 8

      billOfMaterialCategory - BOM category

      Constraints: Not nullable, Maximum length: 1

      billOfMaterialVariant - Alternative BOM

      Constraints: Not nullable, Maximum length: 2

      billOfMaterialItemNodeNumber - BOM item node number

      Constraints: Not nullable, Maximum length: 8

      headerChangeDocument - Change Number

      Constraints: Not nullable, Maximum length: 12

      material - Material Number

      Constraints: Not nullable, Maximum length: 40

      plant - Plant

      Constraints: Not nullable, Maximum length: 4

      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 public SalesOrderBOMItemCreateFluentHelper createSalesOrderBOMItem(@Nonnull SalesOrderBOMItem salesOrderBOMItem)
      Deprecated.
      Description copied from interface: OrderBillOfMaterialService
      Create a new SalesOrderBOMItem entity and save it to the S/4HANA system.
      Specified by:
      createSalesOrderBOMItem in interface OrderBillOfMaterialService
      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 public SalesOrderBOMItemUpdateFluentHelper updateSalesOrderBOMItem(@Nonnull SalesOrderBOMItem salesOrderBOMItem)
      Deprecated.
      Description copied from interface: OrderBillOfMaterialService
      Update an existing SalesOrderBOMItem entity and save it to the S/4HANA system.
      Specified by:
      updateSalesOrderBOMItem in interface OrderBillOfMaterialService
      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 public SalesOrderBOMItemDeleteFluentHelper deleteSalesOrderBOMItem(@Nonnull SalesOrderBOMItem salesOrderBOMItem)
      Deprecated.
      Description copied from interface: OrderBillOfMaterialService
      Deletes an existing SalesOrderBOMItem entity in the S/4HANA system.
      Specified by:
      deleteSalesOrderBOMItem in interface OrderBillOfMaterialService
      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 public SalesOrderBOMFluentHelper getAllSalesOrderBOM()
      Deprecated.
      Description copied from interface: OrderBillOfMaterialService
      Fetch multiple SalesOrderBOM entities.
      Specified by:
      getAllSalesOrderBOM in interface OrderBillOfMaterialService
      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 public SalesOrderBOMByKeyFluentHelper getSalesOrderBOMByKey(String billOfMaterialCategory, String billOfMaterial, String billOfMaterialVariant, String engineeringChangeDocument, String material, String plant)
      Deprecated.
      Description copied from interface: OrderBillOfMaterialService
      Fetch a single SalesOrderBOM entity using key fields.
      Specified by:
      getSalesOrderBOMByKey in interface OrderBillOfMaterialService
      Parameters:
      billOfMaterialCategory - BOM category

      Constraints: Not nullable, Maximum length: 1

      billOfMaterial - Bill of Material

      Constraints: Not nullable, Maximum length: 8

      billOfMaterialVariant - Alternative BOM

      Constraints: Not nullable, Maximum length: 2

      engineeringChangeDocument - Change Number

      Constraints: Not nullable, Maximum length: 12

      material - Material Number

      Constraints: Not nullable, Maximum length: 40

      plant - Plant

      Constraints: Not nullable, Maximum length: 4

      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 public SalesOrderBOMCreateFluentHelper createSalesOrderBOM(@Nonnull SalesOrderBOM salesOrderBOM)
      Deprecated.
      Description copied from interface: OrderBillOfMaterialService
      Create a new SalesOrderBOM entity and save it to the S/4HANA system.
      Specified by:
      createSalesOrderBOM in interface OrderBillOfMaterialService
      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 public SalesOrderBOMUpdateFluentHelper updateSalesOrderBOM(@Nonnull SalesOrderBOM salesOrderBOM)
      Deprecated.
      Description copied from interface: OrderBillOfMaterialService
      Update an existing SalesOrderBOM entity and save it to the S/4HANA system.
      Specified by:
      updateSalesOrderBOM in interface OrderBillOfMaterialService
      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 public SalesOrderBOMDeleteFluentHelper deleteSalesOrderBOM(@Nonnull SalesOrderBOM salesOrderBOM)
      Deprecated.
      Description copied from interface: OrderBillOfMaterialService
      Deletes an existing SalesOrderBOM entity in the S/4HANA system.
      Specified by:
      deleteSalesOrderBOM in interface OrderBillOfMaterialService
      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 public 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.
      Description copied from interface: OrderBillOfMaterialService

      Creates a fluent helper for the DeleteBOMItemWithChangeNumber OData function import.

      Specified by:
      deleteBOMItemWithChangeNumber in interface OrderBillOfMaterialService
      Parameters:
      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

      billOfMaterialItemNodeNumber - Item node

      Constraints: Not nullable, Maximum length: 8

      Original parameter name from the Odata EDM: BillOfMaterialItemNodeNumber

      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

      plant - Plant

      Constraints: Not nullable, Maximum length: 4

      Original parameter name from the Odata EDM: Plant

      engineeringChangeDocForEdit - Change Number

      Constraints: Nullable, Maximum length: 12

      Original parameter name from the Odata EDM: EngineeringChangeDocForEdit

      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 public DeleteBOMHdrWithChangeNumberFluentHelper deleteBOMHdrWithChangeNumber(@Nonnull String billOfMaterialCategory, @Nonnull String billOfMaterial, @Nonnull String billOfMaterialVariant, @Nonnull String engineeringChangeDocument, @Nonnull String material, @Nonnull String plant, @Nullable String engineeringChangeDocForEdit)
      Deprecated.
      Description copied from interface: OrderBillOfMaterialService

      Creates a fluent helper for the DeleteBOMHdrWithChangeNumber OData function import.

      Specified by:
      deleteBOMHdrWithChangeNumber in interface OrderBillOfMaterialService
      Parameters:
      billOfMaterialCategory - BOM category

      Constraints: Not nullable, Maximum length: 1

      Original parameter name from the Odata EDM: BillOfMaterialCategory

      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

      engineeringChangeDocument - Change Number

      Constraints: Not nullable, Maximum length: 12

      Original parameter name from the Odata EDM: EngineeringChangeDocument

      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

      engineeringChangeDocForEdit - Change Number

      Constraints: Nullable, Maximum length: 12

      Original parameter name from the Odata EDM: EngineeringChangeDocForEdit

      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.