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

Interface AllergenStatementService

All Superinterfaces:

BatchService<AllergenStatementServiceBatch>

All Known Implementing Classes:

DefaultAllergenStatementService

public interface AllergenStatementService
extends BatchService<AllergenStatementServiceBatch>

This service reads which specification types are assigned to category ALLERGEN, and can retrieve exception value information from Customizing regarding the associated specification type. You can use the Allergen - Read API to read the header data and description of allergens. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_ALLERGENSTATEMENT_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
AllergenStatementFluentHelper	getAllAllergenStatement() Fetch multiple AllergenStatement entities.
AllergenStatementTextFluentHelper	getAllAllergenStatementText() Fetch multiple AllergenStatementText entities.
AllergenStatementByKeyFluentHelper	getAllergenStatementByKey(String allergenStatement) Fetch a single AllergenStatement entity using key fields.
AllergenStatementTextByKeyFluentHelper	getAllergenStatementTextByKey(String allergenStatement, String language) Fetch a single AllergenStatementText entity using key fields.
AllergenStatementService	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
AllergenStatementService 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.

getAllAllergenStatement

@Nonnull
AllergenStatementFluentHelper getAllAllergenStatement()

Fetch multiple AllergenStatement entities.

Returns:

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

getAllergenStatementByKey

@Nonnull
AllergenStatementByKeyFluentHelper getAllergenStatementByKey(String allergenStatement)

Fetch a single AllergenStatement entity using key fields.

Parameters:

allergenStatement - Allergen Statement

Constraints: Not nullable, Maximum length: 2

Returns:

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

getAllAllergenStatementText

@Nonnull
AllergenStatementTextFluentHelper getAllAllergenStatementText()

Fetch multiple AllergenStatementText entities.

Returns:

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

getAllergenStatementTextByKey

@Nonnull
AllergenStatementTextByKeyFluentHelper getAllergenStatementTextByKey(String allergenStatement,
                                                                              String language)

Fetch a single AllergenStatementText entity using key fields.

Parameters:

allergenStatement - Allergen Statement

Constraints: Not nullable, Maximum length: 2

language - Language Key

Constraints: Not nullable, Maximum length: 2

Returns:

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