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

Interface NutrientService

All Superinterfaces:

BatchService<NutrientServiceBatch>

All Known Implementing Classes:

DefaultNutrientService

public interface NutrientService
extends BatchService<NutrientServiceBatch>

This service reads data from specifications with category NUTRIENT, and can retrieve nutrient header data and description. You can use the Nutrient Statement - Read API to read nutrient exception values. .

Business Documentation

Reference: SAP API Business Hub

Details:

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

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
NutrientFluentHelper	getAllNutrient() Fetch multiple Nutrient entities.
NutrientBaseUnitOfMeasureFluentHelper	getAllNutrientBaseUnitOfMeasure() Fetch multiple NutrientBaseUnitOfMeasure entities.
NutrientDerivedNutrientFluentHelper	getAllNutrientDerivedNutrient() Fetch multiple NutrientDerivedNutrient entities.
NutrientDescriptionFluentHelper	getAllNutrientDescription() Fetch multiple NutrientDescription entities.
NutrientBaseUnitOfMeasureByKeyFluentHelper	getNutrientBaseUnitOfMeasureByKey(String nutrientInternalID) Fetch a single NutrientBaseUnitOfMeasure entity using key fields.
NutrientByKeyFluentHelper	getNutrientByKey(String nutrientInternalID) Fetch a single Nutrient entity using key fields.
NutrientDerivedNutrientByKeyFluentHelper	getNutrientDerivedNutrientByKey(String nutrientInternalID) Fetch a single NutrientDerivedNutrient entity using key fields.
NutrientDescriptionByKeyFluentHelper	getNutrientDescriptionByKey(String nutrientInternalID, String nutrientDescriptionLanguage) Fetch a single NutrientDescription entity using key fields.
NutrientService	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
NutrientService 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.

getAllNutrient

@Nonnull
NutrientFluentHelper getAllNutrient()

Fetch multiple Nutrient entities.

Returns:

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

getNutrientByKey

@Nonnull
NutrientByKeyFluentHelper getNutrientByKey(String nutrientInternalID)

Fetch a single Nutrient entity using key fields.

Parameters:

nutrientInternalID - Nutrient Internal ID

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllNutrientBaseUnitOfMeasure

@Nonnull
NutrientBaseUnitOfMeasureFluentHelper getAllNutrientBaseUnitOfMeasure()

Fetch multiple NutrientBaseUnitOfMeasure entities.

Returns:

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

getNutrientBaseUnitOfMeasureByKey

@Nonnull
NutrientBaseUnitOfMeasureByKeyFluentHelper getNutrientBaseUnitOfMeasureByKey(String nutrientInternalID)

Fetch a single NutrientBaseUnitOfMeasure entity using key fields.

Parameters:

nutrientInternalID - Sequential Number of Data Record

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllNutrientDerivedNutrient

@Nonnull
NutrientDerivedNutrientFluentHelper getAllNutrientDerivedNutrient()

Fetch multiple NutrientDerivedNutrient entities.

Returns:

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

getNutrientDerivedNutrientByKey

@Nonnull
NutrientDerivedNutrientByKeyFluentHelper getNutrientDerivedNutrientByKey(String nutrientInternalID)

Fetch a single NutrientDerivedNutrient entity using key fields.

Parameters:

nutrientInternalID - Sequential Number of Data Record

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllNutrientDescription

@Nonnull
NutrientDescriptionFluentHelper getAllNutrientDescription()

Fetch multiple NutrientDescription entities.

Returns:

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

getNutrientDescriptionByKey

@Nonnull
NutrientDescriptionByKeyFluentHelper getNutrientDescriptionByKey(String nutrientInternalID,
                                                                          String nutrientDescriptionLanguage)

Fetch a single NutrientDescription entity using key fields.

Parameters:

nutrientInternalID - Sequential Number of Data Record

Constraints: Not nullable, Maximum length: 20

nutrientDescriptionLanguage - Language

Constraints: Not nullable, Maximum length: 2

Returns:

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