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

Interface AllergenService

All Superinterfaces:

BatchService<AllergenServiceBatch>

All Known Implementing Classes:

DefaultAllergenService

public interface AllergenService
extends BatchService<AllergenServiceBatch>

The service reads data from specifications with category allergen, and can retrieve allergen header data and description. You can use the Allergen Statement - Read API to read allergen exception values. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_ALLERGEN_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Allergen

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
AllergenFluentHelper	getAllAllergen() Fetch multiple Allergen entities.
AllergenDescriptionFluentHelper	getAllAllergenDescription() Fetch multiple AllergenDescription entities.
AllergenByKeyFluentHelper	getAllergenByKey(String allergenInternalID) Fetch a single Allergen entity using key fields.
AllergenDescriptionByKeyFluentHelper	getAllergenDescriptionByKey(String allergenInternalID, String allergenDescriptionLanguage) Fetch a single AllergenDescription entity using key fields.
AllergenService	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
AllergenService 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.

getAllAllergen

@Nonnull
AllergenFluentHelper getAllAllergen()

Fetch multiple Allergen entities.

Returns:

A fluent helper to fetch multiple Allergen 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.

getAllergenByKey

@Nonnull
AllergenByKeyFluentHelper getAllergenByKey(String allergenInternalID)

Fetch a single Allergen entity using key fields.

Parameters:

allergenInternalID - Allergen Internal ID

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllAllergenDescription

@Nonnull
AllergenDescriptionFluentHelper getAllAllergenDescription()

Fetch multiple AllergenDescription entities.

Returns:

A fluent helper to fetch multiple AllergenDescription 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.

getAllergenDescriptionByKey

@Nonnull
AllergenDescriptionByKeyFluentHelper getAllergenDescriptionByKey(String allergenInternalID,
                                                                          String allergenDescriptionLanguage)

Fetch a single AllergenDescription entity using key fields.

Parameters:

allergenInternalID - Sequential Number of Data Record

Constraints: Not nullable, Maximum length: 20

allergenDescriptionLanguage - Language

Constraints: Not nullable, Maximum length: 2

Returns:

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