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

Class DefaultBatchService

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

  • Constructor Details

  • Method Details

    • withServicePath

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

    • batch

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

    • getAllBatch

      @Nonnull public BatchFluentHelper getAllBatch()
      Deprecated.
      Description copied from interface: BatchService
      Fetch multiple Batch entities.
      Specified by:
      getAllBatch in interface BatchService
      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 public BatchByKeyFluentHelper getBatchByKey(String material, String batchIdentifyingPlant, String batch)
      Deprecated.
      Description copied from interface: BatchService
      Fetch a single Batch entity using key fields.
      Specified by:
      getBatchByKey in interface BatchService
      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 public BatchCreateFluentHelper createBatch(@Nonnull Batch batch)
      Deprecated.
      Description copied from interface: BatchService
      Create a new Batch entity and save it to the S/4HANA system.
      Specified by:
      createBatch in interface BatchService
      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 public BatchUpdateFluentHelper updateBatch(@Nonnull Batch batch)
      Deprecated.
      Description copied from interface: BatchService
      Update an existing Batch entity and save it to the S/4HANA system.
      Specified by:
      updateBatch in interface BatchService
      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 public BatchCharcFluentHelper getAllBatchCharc()
      Deprecated.
      Description copied from interface: BatchService
      Fetch multiple BatchCharc entities.
      Specified by:
      getAllBatchCharc in interface BatchService
      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 public BatchCharcByKeyFluentHelper getBatchCharcByKey(String material, String batchIdentifyingPlant, String batch, String charcInternalID)
      Deprecated.
      Description copied from interface: BatchService
      Fetch a single BatchCharc entity using key fields.
      Specified by:
      getBatchCharcByKey in interface BatchService
      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

      charcInternalID - Characteristic Internal ID

      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 public BatchCharcCreateFluentHelper createBatchCharc(@Nonnull BatchCharc batchCharc)
      Deprecated.
      Description copied from interface: BatchService
      Create a new BatchCharc entity and save it to the S/4HANA system.
      Specified by:
      createBatchCharc in interface BatchService
      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 public BatchCharcValueFluentHelper getAllBatchCharcValue()
      Deprecated.
      Description copied from interface: BatchService
      Fetch multiple BatchCharcValue entities.
      Specified by:
      getAllBatchCharcValue in interface BatchService
      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 public BatchCharcValueByKeyFluentHelper getBatchCharcValueByKey(String material, String batchIdentifyingPlant, String batch, String charcInternalID, String charcValuePositionNumber)
      Deprecated.
      Description copied from interface: BatchService
      Fetch a single BatchCharcValue entity using key fields.
      Specified by:
      getBatchCharcValueByKey in interface BatchService
      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

      charcInternalID - Characteristic Internal ID

      Constraints: Not nullable, Maximum length: 10

      charcValuePositionNumber - Characteristic value counter

      Constraints: Not nullable, Maximum length: 3

      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 public BatchCharcValueCreateFluentHelper createBatchCharcValue(@Nonnull BatchCharcValue batchCharcValue)
      Deprecated.
      Description copied from interface: BatchService
      Create a new BatchCharcValue entity and save it to the S/4HANA system.
      Specified by:
      createBatchCharcValue in interface BatchService
      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 public BatchCharcValueUpdateFluentHelper updateBatchCharcValue(@Nonnull BatchCharcValue batchCharcValue)
      Deprecated.
      Description copied from interface: BatchService
      Update an existing BatchCharcValue entity and save it to the S/4HANA system.
      Specified by:
      updateBatchCharcValue in interface BatchService
      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 public BatchCharcValueDeleteFluentHelper deleteBatchCharcValue(@Nonnull BatchCharcValue batchCharcValue)
      Deprecated.
      Description copied from interface: BatchService
      Deletes an existing BatchCharcValue entity in the S/4HANA system.
      Specified by:
      deleteBatchCharcValue in interface BatchService
      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 public BatchClassFluentHelper getAllBatchClass()
      Deprecated.
      Description copied from interface: BatchService
      Fetch multiple BatchClass entities.
      Specified by:
      getAllBatchClass in interface BatchService
      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 public BatchClassByKeyFluentHelper getBatchClassByKey(String material, String batchIdentifyingPlant, String batch)
      Deprecated.
      Description copied from interface: BatchService
      Fetch a single BatchClass entity using key fields.
      Specified by:
      getBatchClassByKey in interface BatchService
      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 public BatchClassCreateFluentHelper createBatchClass(@Nonnull BatchClass batchClass)
      Deprecated.
      Description copied from interface: BatchService
      Create a new BatchClass entity and save it to the S/4HANA system.
      Specified by:
      createBatchClass in interface BatchService
      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 public BatchClassDeleteFluentHelper deleteBatchClass(@Nonnull BatchClass batchClass)
      Deprecated.
      Description copied from interface: BatchService
      Deletes an existing BatchClass entity in the S/4HANA system.
      Specified by:
      deleteBatchClass in interface BatchService
      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 public BatchPlantFluentHelper getAllBatchPlant()
      Deprecated.
      Description copied from interface: BatchService
      Fetch multiple BatchPlant entities.
      Specified by:
      getAllBatchPlant in interface BatchService
      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 public BatchPlantByKeyFluentHelper getBatchPlantByKey(String material, String batch, String plant)
      Deprecated.
      Description copied from interface: BatchService
      Fetch a single BatchPlant entity using key fields.
      Specified by:
      getBatchPlantByKey in interface BatchService
      Parameters:
      material - Material Number

      Constraints: Not nullable, Maximum length: 18

      batch - Batch Number

      Constraints: Not nullable, Maximum length: 10

      plant - Plant

      Constraints: Not nullable, Maximum length: 4

      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 public BatchPlantUpdateFluentHelper updateBatchPlant(@Nonnull BatchPlant batchPlant)
      Deprecated.
      Description copied from interface: BatchService
      Update an existing BatchPlant entity and save it to the S/4HANA system.
      Specified by:
      updateBatchPlant in interface BatchService
      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 public BatchTextFluentHelper getAllBatchText()
      Deprecated.
      Description copied from interface: BatchService
      Fetch multiple BatchText entities.
      Specified by:
      getAllBatchText in interface BatchService
      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 public BatchTextByKeyFluentHelper getBatchTextByKey(String material, String batchIdentifyingPlant, String batch, String language)
      Deprecated.
      Description copied from interface: BatchService
      Fetch a single BatchText entity using key fields.
      Specified by:
      getBatchTextByKey in interface BatchService
      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 public BatchTextUpdateFluentHelper updateBatchText(@Nonnull BatchText batchText)
      Deprecated.
      Description copied from interface: BatchService
      Update an existing BatchText entity and save it to the S/4HANA system.
      Specified by:
      updateBatchText in interface BatchService
      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 public BatchTextDeleteFluentHelper deleteBatchText(@Nonnull BatchText batchText)
      Deprecated.
      Description copied from interface: BatchService
      Deletes an existing BatchText entity in the S/4HANA system.
      Specified by:
      deleteBatchText in interface BatchService
      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.