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

Interface PureSubstanceService

All Superinterfaces:

BatchService<PureSubstanceServiceBatch>

All Known Implementing Classes:

DefaultPureSubstanceService

public interface PureSubstanceService
extends BatchService<PureSubstanceServiceBatch>

This service reads data from specifications with category pure substance, and can retrieve pure substance header data and description. You can use the Pure Substance Component Type - Read API to read pure substance component types. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_PURESUBSTANCE_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Recipe Pure Substance

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
PureSubstanceFluentHelper	getAllPureSubstance() Fetch multiple PureSubstance entities.
PureSubstanceDescriptionFluentHelper	getAllPureSubstanceDescription() Fetch multiple PureSubstanceDescription entities.
PureSubstanceByKeyFluentHelper	getPureSubstanceByKey(String pureSubstanceInternalID) Fetch a single PureSubstance entity using key fields.
PureSubstanceDescriptionByKeyFluentHelper	getPureSubstanceDescriptionByKey(String pureSubstanceInternalID, String pureSubstanceDescriptionLang) Fetch a single PureSubstanceDescription entity using key fields.
PureSubstanceService	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
PureSubstanceService 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.

getAllPureSubstance

@Nonnull
PureSubstanceFluentHelper getAllPureSubstance()

Fetch multiple PureSubstance entities.

Returns:

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

getPureSubstanceByKey

@Nonnull
PureSubstanceByKeyFluentHelper getPureSubstanceByKey(String pureSubstanceInternalID)

Fetch a single PureSubstance entity using key fields.

Parameters:

pureSubstanceInternalID - Pure Substance Internal ID

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllPureSubstanceDescription

@Nonnull
PureSubstanceDescriptionFluentHelper getAllPureSubstanceDescription()

Fetch multiple PureSubstanceDescription entities.

Returns:

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

getPureSubstanceDescriptionByKey

@Nonnull
PureSubstanceDescriptionByKeyFluentHelper getPureSubstanceDescriptionByKey(String pureSubstanceInternalID,
                                                                                    String pureSubstanceDescriptionLang)

Fetch a single PureSubstanceDescription entity using key fields.

Parameters:

pureSubstanceDescriptionLang - Language

Constraints: Not nullable, Maximum length: 2

pureSubstanceInternalID - Sequential Number of Data Record

Constraints: Not nullable, Maximum length: 20

Returns:

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