@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultBatchService") public class DefaultBatchService extends Object implements BatchService
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. .
Reference: SAP API Business Hub
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 |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultBatchService()
Creates a service using
BatchService.DEFAULT_SERVICE_PATH to send the requests. |
Modifier and Type | Method and Description |
---|---|
DefaultBatchServiceBatch |
batch()
Instantiate a new FluentHelper instance for a single OData batch request.
|
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. |
DefaultBatchService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
public DefaultBatchService()
BatchService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultBatchService withServicePath(@Nonnull String servicePath)
BatchService
servicePath
- Service path that will override the default.@Nonnull public DefaultBatchServiceBatch batch()
batch
in interface BatchService<BatchServiceBatch>
@Nonnull public BatchFluentHelper getAllBatch()
BatchService
Batch
entities.@Nonnull public BatchByKeyFluentHelper getBatchByKey(String material, String batchIdentifyingPlant, String batch)
BatchService
Batch
entity using key
fields.material
- Alphanumeric key uniquely identifying the material.
Constraints: Not nullable, Maximum length: 18
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
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.@Nonnull public BatchCreateFluentHelper createBatch(@Nonnull Batch batch)
BatchService
Batch
entity and save it to
the S/4HANA system.@Nonnull public BatchUpdateFluentHelper updateBatch(@Nonnull Batch batch)
BatchService
Batch
entity and save
it to the S/4HANA system.@Nonnull public BatchCharcFluentHelper getAllBatchCharc()
BatchService
BatchCharc
entities.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.@Nonnull public BatchCharcByKeyFluentHelper getBatchCharcByKey(String material, String batchIdentifyingPlant, String batch, String charcInternalID)
BatchService
BatchCharc
entity
using key fields.material
- Alphanumeric key uniquely identifying the material.
Constraints: Not nullable, Maximum length: 18
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
charcInternalID
- Internal characteristic number without conversion routine
Constraints: Not nullable, Maximum length: 10
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.@Nonnull public BatchCharcCreateFluentHelper createBatchCharc(@Nonnull BatchCharc batchCharc)
BatchService
BatchCharc
entity and
save it to the S/4HANA system.batchCharc
- BatchCharc
entity object
that will be created in the S/4HANA system.BatchCharc
entity. To
perform execution, call the
execute
method on the fluent helper object.@Nonnull public BatchCharcValueFluentHelper getAllBatchCharcValue()
BatchService
BatchCharcValue
entities.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.@Nonnull public BatchCharcValueByKeyFluentHelper getBatchCharcValueByKey(String material, String batchIdentifyingPlant, String batch, String charcInternalID, String charcValuePositionNumber)
BatchService
BatchCharcValue
entity using key fields.material
- Alphanumeric key uniquely identifying the material.
Constraints: Not nullable, Maximum length: 18
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
charcInternalID
- Internal characteristic number without conversion routine
Constraints: Not nullable, Maximum length: 10
charcValuePositionNumber
- Characteristic value counter
Constraints: Not nullable, Maximum length: 3
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.@Nonnull public BatchCharcValueCreateFluentHelper createBatchCharcValue(@Nonnull BatchCharcValue batchCharcValue)
BatchService
BatchCharcValue
entity and save it to the S/4HANA system.batchCharcValue
- BatchCharcValue
entity object that will be created in the S/4HANA system.BatchCharcValue
entity.
To perform execution, call the
execute
method on the fluent helper object.@Nonnull public BatchCharcValueUpdateFluentHelper updateBatchCharcValue(@Nonnull BatchCharcValue batchCharcValue)
BatchService
BatchCharcValue
entity and save it to the S/4HANA system.batchCharcValue
- BatchCharcValue
entity object that will be updated in the S/4HANA system.BatchCharcValue
entity.
To perform execution, call the
execute
method on the fluent helper object.@Nonnull public BatchCharcValueDeleteFluentHelper deleteBatchCharcValue(@Nonnull BatchCharcValue batchCharcValue)
BatchService
BatchCharcValue
entity in the S/4HANA system.batchCharcValue
- BatchCharcValue
entity object that will be deleted in the S/4HANA system.BatchCharcValue
entity.
To perform execution, call the
execute
method on the fluent helper object.@Nonnull public BatchClassFluentHelper getAllBatchClass()
BatchService
BatchClass
entities.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.@Nonnull public BatchClassByKeyFluentHelper getBatchClassByKey(String material, String batchIdentifyingPlant, String batch)
BatchService
BatchClass
entity
using key fields.material
- Alphanumeric key uniquely identifying the material.
Constraints: Not nullable, Maximum length: 18
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
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.@Nonnull public BatchClassCreateFluentHelper createBatchClass(@Nonnull BatchClass batchClass)
BatchService
BatchClass
entity and
save it to the S/4HANA system.batchClass
- BatchClass
entity object
that will be created in the S/4HANA system.BatchClass
entity. To
perform execution, call the
execute
method on the fluent helper object.@Nonnull public BatchClassDeleteFluentHelper deleteBatchClass(@Nonnull BatchClass batchClass)
BatchService
BatchClass
entity in the S/4HANA system.batchClass
- BatchClass
entity object
that will be deleted in the S/4HANA system.BatchClass
entity. To
perform execution, call the
execute
method on the fluent helper object.@Nonnull public BatchPlantFluentHelper getAllBatchPlant()
BatchService
BatchPlant
entities.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.@Nonnull public BatchPlantByKeyFluentHelper getBatchPlantByKey(String material, String batch, String plant)
BatchService
BatchPlant
entity
using key fields.material
- Alphanumeric key uniquely identifying the material.
Constraints: Not nullable, Maximum length: 18
batch
- Assigns a material that is manufactured in batches or production lots to a specific batch.
Constraints: Not nullable, Maximum length: 10
plant
- Key uniquely identifying a plant.
Constraints: Not nullable, Maximum length: 4
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.@Nonnull public BatchPlantUpdateFluentHelper updateBatchPlant(@Nonnull BatchPlant batchPlant)
BatchService
BatchPlant
entity
and save it to the S/4HANA system.batchPlant
- BatchPlant
entity object
that will be updated in the S/4HANA system.BatchPlant
entity. To
perform execution, call the
execute
method on the fluent helper object.Copyright © 2020 SAP SE. All rights reserved.