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

Interface BatchService

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

This synchronous inbound API enables you to read, create and change batches. Additionally, it is possible to retrieve and to edit the related classification data. The service is based on the OData protocol, and can be consumed by external systems and user interfaces. .

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: API_BATCH_SRV
API Version: 1.1.1
Minimum ERP Version: 2302
Communication Scenario: Batch Management OData Integration(SAP_COM_0337), Excise Tax Integration(SAP_COM_0568)
Scope Items: Batch Management(BLF), Enablement of SAP Excise Tax Management(4LO)
Authentication Methods: x509
Business Object: Batch

  • Field Details

  • Method Details

    • withServicePath

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

    • getAllBatch

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

    • getBatchByKey

      @Nonnull BatchByKeyFluentHelper getBatchByKey(String material, String batchIdentifyingPlant, String batch)
      Deprecated.
      Fetch a single Batch entity using key fields.
      Parameters:
      material - Material Number

      Constraints: Not nullable, Maximum length: 18

      batchIdentifyingPlant - Plant

      Constraints: Not nullable, Maximum length: 4

      batch - Batch Number

      Constraints: Not nullable, Maximum length: 10

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

    • createBatch

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

    • updateBatch

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

    • getAllBatchCharc

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

    • getBatchCharcByKey

      @Nonnull BatchCharcByKeyFluentHelper getBatchCharcByKey(String material, String batchIdentifyingPlant, String batch, String charcInternalID)
      Deprecated.
      Fetch a single BatchCharc entity using key fields.
      Parameters:
      material - Material Number

      Constraints: Not nullable, Maximum length: 18

      charcInternalID - Characteristic Internal ID

      Constraints: Not nullable, Maximum length: 10

      batchIdentifyingPlant - Plant

      Constraints: Not nullable, Maximum length: 4

      batch - Batch Number

      Constraints: Not nullable, Maximum length: 10

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

    • createBatchCharc

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

    • getAllBatchCharcValue

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

    • getBatchCharcValueByKey

      @Nonnull BatchCharcValueByKeyFluentHelper getBatchCharcValueByKey(String material, String batchIdentifyingPlant, String batch, String charcInternalID, String charcValuePositionNumber)
      Deprecated.
      Fetch a single BatchCharcValue entity using key fields.
      Parameters:
      charcValuePositionNumber - Characteristic value counter

      Constraints: Not nullable, Maximum length: 3

      material - Material Number

      Constraints: Not nullable, Maximum length: 18

      charcInternalID - Characteristic Internal ID

      Constraints: Not nullable, Maximum length: 10

      batchIdentifyingPlant - Plant

      Constraints: Not nullable, Maximum length: 4

      batch - Batch Number

      Constraints: Not nullable, Maximum length: 10

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

    • createBatchCharcValue

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

    • updateBatchCharcValue

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

    • deleteBatchCharcValue

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

    • getAllBatchClass

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

    • getBatchClassByKey

      @Nonnull BatchClassByKeyFluentHelper getBatchClassByKey(String material, String batchIdentifyingPlant, String batch)
      Deprecated.
      Fetch a single BatchClass entity using key fields.
      Parameters:
      material - Material Number

      Constraints: Not nullable, Maximum length: 18

      batchIdentifyingPlant - Plant

      Constraints: Not nullable, Maximum length: 4

      batch - Batch Number

      Constraints: Not nullable, Maximum length: 10

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

    • createBatchClass

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

    • deleteBatchClass

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

    • getAllBatchPlant

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

    • getBatchPlantByKey

      @Nonnull BatchPlantByKeyFluentHelper getBatchPlantByKey(String material, String batch, String plant)
      Deprecated.
      Fetch a single BatchPlant entity using key fields.
      Parameters:
      material - Material Number

      Constraints: Not nullable, Maximum length: 18

      plant - Plant

      Constraints: Not nullable, Maximum length: 4

      batch - Batch Number

      Constraints: Not nullable, Maximum length: 10

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

    • updateBatchPlant

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

    • getAllBatchText

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

    • getBatchTextByKey

      @Nonnull BatchTextByKeyFluentHelper getBatchTextByKey(String material, String batchIdentifyingPlant, String batch, String language)
      Deprecated.
      Fetch a single BatchText entity using key fields.
      Parameters:
      material - Material Number

      Constraints: Not nullable, Maximum length: 18

      batchIdentifyingPlant - Plant

      Constraints: Not nullable, Maximum length: 4

      batch - Batch Number

      Constraints: Not nullable, Maximum length: 10

      language - Language Key

      Constraints: Not nullable, Maximum length: 2

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

    • updateBatchText

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

    • deleteBatchText

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