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

Interface SpecificationPhraseService

All Superinterfaces:

BatchService<SpecificationPhraseServiceBatch>

All Known Implementing Classes:

DefaultSpecificationPhraseService

public interface SpecificationPhraseService
extends BatchService<SpecificationPhraseServiceBatch>

This service enables you to read specification phrase data, such as phrase sets, phrases, and phrase items. The API retrieves header, item, and assignment between phrase sets and phrases via standard HTTP GET call. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_SPECIFICATIONPHRASE_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Recipe Product Specification

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
SpecificationPhraseFluentHelper	getAllSpecificationPhrase() Fetch multiple SpecificationPhrase entities.
SpecificationPhraseItemFluentHelper	getAllSpecificationPhraseItem() Fetch multiple SpecificationPhraseItem entities.
SpecificationPhraseSetFluentHelper	getAllSpecificationPhraseSet() Fetch multiple SpecificationPhraseSet entities.
SpecificationPhraseSetTextFluentHelper	getAllSpecificationPhraseSetText() Fetch multiple SpecificationPhraseSetText entities.
SpecPhraseSetPhraseAssgmtFluentHelper	getAllSpecPhraseSetPhraseAssgmt() Fetch multiple SpecPhraseSetPhraseAssgmt entities.
SpecificationPhraseByKeyFluentHelper	getSpecificationPhraseByKey(String specPhraseInternalID, String specPhraseChgIntID) Fetch a single SpecificationPhrase entity using key fields.
SpecificationPhraseItemByKeyFluentHelper	getSpecificationPhraseItemByKey(String specPhraseItemInternalID, String specPhraseItemChgIntID) Fetch a single SpecificationPhraseItem entity using key fields.
SpecificationPhraseSetByKeyFluentHelper	getSpecificationPhraseSetByKey(String specPhraseSetInternalID, String specPhraseSetChgIntID) Fetch a single SpecificationPhraseSet entity using key fields.
SpecificationPhraseSetTextByKeyFluentHelper	getSpecificationPhraseSetTextByKey(String specPhraseSetDescIntID, String specPhraseSetDescChgIntID) Fetch a single SpecificationPhraseSetText entity using key fields.
SpecPhraseSetPhraseAssgmtByKeyFluentHelper	getSpecPhraseSetPhraseAssgmtByKey(String specPhraseAssgmtInternalID, String specPhraseAssgmtChgIntID) Fetch a single SpecPhraseSetPhraseAssgmt entity using key fields.
SpecificationPhraseService	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
SpecificationPhraseService 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.

getAllSpecificationPhrase

@Nonnull
SpecificationPhraseFluentHelper getAllSpecificationPhrase()

Fetch multiple SpecificationPhrase entities.

Returns:

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

getSpecificationPhraseByKey

@Nonnull
SpecificationPhraseByKeyFluentHelper getSpecificationPhraseByKey(String specPhraseInternalID,
                                                                          String specPhraseChgIntID)

Fetch a single SpecificationPhrase entity using key fields.

Parameters:

specPhraseChgIntID - Phrase Change State

Constraints: Not nullable, Maximum length: 20

specPhraseInternalID - Phrase Internal ID

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllSpecificationPhraseItem

@Nonnull
SpecificationPhraseItemFluentHelper getAllSpecificationPhraseItem()

Fetch multiple SpecificationPhraseItem entities.

Returns:

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

getSpecificationPhraseItemByKey

@Nonnull
SpecificationPhraseItemByKeyFluentHelper getSpecificationPhraseItemByKey(String specPhraseItemInternalID,
                                                                                  String specPhraseItemChgIntID)

Fetch a single SpecificationPhraseItem entity using key fields.

Parameters:

specPhraseItemChgIntID - Phrase Item Change State

Constraints: Not nullable, Maximum length: 20

specPhraseItemInternalID - Phrase Item Internal ID

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllSpecificationPhraseSet

@Nonnull
SpecificationPhraseSetFluentHelper getAllSpecificationPhraseSet()

Fetch multiple SpecificationPhraseSet entities.

Returns:

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

getSpecificationPhraseSetByKey

@Nonnull
SpecificationPhraseSetByKeyFluentHelper getSpecificationPhraseSetByKey(String specPhraseSetInternalID,
                                                                                String specPhraseSetChgIntID)

Fetch a single SpecificationPhraseSet entity using key fields.

Parameters:

specPhraseSetInternalID - Phrase Set Internal ID

Constraints: Not nullable, Maximum length: 20

specPhraseSetChgIntID - Phrase Set Change State

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllSpecificationPhraseSetText

@Nonnull
SpecificationPhraseSetTextFluentHelper getAllSpecificationPhraseSetText()

Fetch multiple SpecificationPhraseSetText entities.

Returns:

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

getSpecificationPhraseSetTextByKey

@Nonnull
SpecificationPhraseSetTextByKeyFluentHelper getSpecificationPhraseSetTextByKey(String specPhraseSetDescIntID,
                                                                                        String specPhraseSetDescChgIntID)

Fetch a single SpecificationPhraseSetText entity using key fields.

Parameters:

specPhraseSetDescIntID - Sequential Number of Data Record

Constraints: Not nullable, Maximum length: 20

specPhraseSetDescChgIntID - Sequential Number of the Change State

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllSpecPhraseSetPhraseAssgmt

@Nonnull
SpecPhraseSetPhraseAssgmtFluentHelper getAllSpecPhraseSetPhraseAssgmt()

Fetch multiple SpecPhraseSetPhraseAssgmt entities.

Returns:

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

getSpecPhraseSetPhraseAssgmtByKey

@Nonnull
SpecPhraseSetPhraseAssgmtByKeyFluentHelper getSpecPhraseSetPhraseAssgmtByKey(String specPhraseAssgmtInternalID,
                                                                                      String specPhraseAssgmtChgIntID)

Fetch a single SpecPhraseSetPhraseAssgmt entity using key fields.

Parameters:

specPhraseAssgmtInternalID - Phrase Set - Phrase Assignment Internal ID

Constraints: Not nullable, Maximum length: 20

specPhraseAssgmtChgIntID - Phrase Set - Phrase Assignment Change State

Constraints: Not nullable, Maximum length: 20

Returns:

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