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

Class DefaultAllergenService

java.lang.Object

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

All Implemented Interfaces:

BatchService<AllergenServiceBatch>, AllergenService

@Named(value="com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.DefaultAllergenService")
public class DefaultAllergenService
extends Object
implements AllergenService

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 inherited from interface com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.AllergenService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultAllergenService() Creates a service using AllergenService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultAllergenServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultAllergenService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultAllergenService

public DefaultAllergenService()

Creates a service using AllergenService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultAllergenService withServicePath(@Nonnull
                                                       String servicePath)

Description copied from interface: AllergenService

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 AllergenService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultAllergenServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<AllergenServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllAllergen

@Nonnull
public AllergenFluentHelper getAllAllergen()

Description copied from interface: AllergenService

Fetch multiple Allergen entities.

Specified by:

getAllAllergen in interface AllergenService

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
public AllergenByKeyFluentHelper getAllergenByKey(String allergenInternalID)

Description copied from interface: AllergenService

Fetch a single Allergen entity using key fields.

Specified by:

getAllergenByKey in interface AllergenService

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
public AllergenDescriptionFluentHelper getAllAllergenDescription()

Description copied from interface: AllergenService

Fetch multiple AllergenDescription entities.

Specified by:

getAllAllergenDescription in interface AllergenService

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
public AllergenDescriptionByKeyFluentHelper getAllergenDescriptionByKey(String allergenInternalID,
                                                                                 String allergenDescriptionLanguage)

Description copied from interface: AllergenService

Fetch a single AllergenDescription entity using key fields.

Specified by:

getAllergenDescriptionByKey in interface AllergenService

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.