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

Interface BatchService

All Superinterfaces:

BatchService<BatchServiceBatch>

public interface BatchService
extends BatchService<BatchServiceBatch>

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 API Business Hub

Details:

OData Service:	API_BATCH_SRV
API Version:	1
Communication Scenario:	Batch Management OData Integration (SAP_COM_0337)
Scope Items:	Batch Management (BLF)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	Batch

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
BatchCreateFluentHelper	createBatch(Batch batch) Create a new Batch entity and save it to the S/4HANA system.
BatchCharcCreateFluentHelper	createBatchCharc(BatchCharc batchCharc) Create a new BatchCharc entity and save it to the S/4HANA system.
BatchCharcValueCreateFluentHelper	createBatchCharcValue(BatchCharcValue batchCharcValue) Create a new BatchCharcValue entity and save it to the S/4HANA system.
BatchClassCreateFluentHelper	createBatchClass(BatchClass batchClass) Create a new BatchClass entity and save it to the S/4HANA system.
BatchCharcValueDeleteFluentHelper	deleteBatchCharcValue(BatchCharcValue batchCharcValue) Deletes an existing BatchCharcValue entity in the S/4HANA system.
BatchClassDeleteFluentHelper	deleteBatchClass(BatchClass batchClass) Deletes an existing BatchClass entity in the S/4HANA system.
BatchFluentHelper	getAllBatch() Fetch multiple Batch entities.
BatchCharcFluentHelper	getAllBatchCharc() Fetch multiple BatchCharc entities.
BatchCharcValueFluentHelper	getAllBatchCharcValue() Fetch multiple BatchCharcValue entities.
BatchClassFluentHelper	getAllBatchClass() Fetch multiple BatchClass entities.
BatchPlantFluentHelper	getAllBatchPlant() Fetch multiple BatchPlant entities.
BatchByKeyFluentHelper	getBatchByKey(String material, String batchIdentifyingPlant, String batch) Fetch a single Batch entity using key fields.
BatchCharcByKeyFluentHelper	getBatchCharcByKey(String material, String batchIdentifyingPlant, String batch, String charcInternalID) Fetch a single BatchCharc entity using key fields.
BatchCharcValueByKeyFluentHelper	getBatchCharcValueByKey(String material, String batchIdentifyingPlant, String batch, String charcInternalID, String charcValuePositionNumber) Fetch a single BatchCharcValue entity using key fields.
BatchClassByKeyFluentHelper	getBatchClassByKey(String material, String batchIdentifyingPlant, String batch) Fetch a single BatchClass entity using key fields.
BatchPlantByKeyFluentHelper	getBatchPlantByKey(String material, String batch, String plant) Fetch a single BatchPlant entity using key fields.
BatchUpdateFluentHelper	updateBatch(Batch batch) Update an existing Batch entity and save it to the S/4HANA system.
BatchCharcValueUpdateFluentHelper	updateBatchCharcValue(BatchCharcValue batchCharcValue) Update an existing BatchCharcValue entity and save it to the S/4HANA system.
BatchPlantUpdateFluentHelper	updateBatchPlant(BatchPlant batchPlant) Update an existing BatchPlant entity and save it to the S/4HANA system.
BatchService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
BatchService withServicePath(@Nonnull
                                      String servicePath)

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()

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)

Fetch a single Batch entity using key fields.

Parameters:

material - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 16

batchIdentifyingPlant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

batch - Assigns a material that is manufactured in batches or production lots to a specific batch.

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)

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)

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()

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)

Fetch a single BatchCharc entity using key fields.

Parameters:

material - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 16

charcInternalID - Internal characteristic number without conversion routine

Constraints: Not nullable, Maximum length: 10

batchIdentifyingPlant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

batch - Assigns a material that is manufactured in batches or production lots to a specific batch.

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)

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()

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)

Fetch a single BatchCharcValue entity using key fields.

Parameters:

charcValuePositionNumber - Characteristic value counter

Constraints: Not nullable, Maximum length: 3

material - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 16

charcInternalID - Internal characteristic number without conversion routine

Constraints: Not nullable, Maximum length: 10

batchIdentifyingPlant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

batch - Assigns a material that is manufactured in batches or production lots to a specific batch.

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)

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)

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)

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()

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)

Fetch a single BatchClass entity using key fields.

Parameters:

material - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 16

batchIdentifyingPlant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

batch - Assigns a material that is manufactured in batches or production lots to a specific batch.

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)

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)

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()

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)

Fetch a single BatchPlant entity using key fields.

Parameters:

material - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 16

plant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

batch - Assigns a material that is manufactured in batches or production lots to a specific batch.

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)

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.