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

Class DefaultSpecificationPhraseService

java.lang.Object

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

All Implemented Interfaces:

BatchService<SpecificationPhraseServiceBatch>, SpecificationPhraseService

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

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultSpecificationPhraseService() Creates a service using SpecificationPhraseService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultSpecificationPhraseServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultSpecificationPhraseService	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

DefaultSpecificationPhraseService

public DefaultSpecificationPhraseService()

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

Method Detail

withServicePath

@Nonnull
public DefaultSpecificationPhraseService withServicePath(@Nonnull
                                                                  String servicePath)

Description copied from interface: SpecificationPhraseService

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 SpecificationPhraseService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultSpecificationPhraseServiceBatch batch()

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

Specified by:

batch in interface BatchService<SpecificationPhraseServiceBatch>

Returns:

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

getAllSpecificationPhrase

@Nonnull
public SpecificationPhraseFluentHelper getAllSpecificationPhrase()

Description copied from interface: SpecificationPhraseService

Fetch multiple SpecificationPhrase entities.

Specified by:

getAllSpecificationPhrase in interface SpecificationPhraseService

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
public SpecificationPhraseByKeyFluentHelper getSpecificationPhraseByKey(String specPhraseInternalID,
                                                                                 String specPhraseChgIntID)

Description copied from interface: SpecificationPhraseService

Fetch a single SpecificationPhrase entity using key fields.

Specified by:

getSpecificationPhraseByKey in interface SpecificationPhraseService

Parameters:

specPhraseInternalID - Phrase Internal ID

Constraints: Not nullable, Maximum length: 20

specPhraseChgIntID - Phrase Change State

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
public SpecificationPhraseItemFluentHelper getAllSpecificationPhraseItem()

Description copied from interface: SpecificationPhraseService

Fetch multiple SpecificationPhraseItem entities.

Specified by:

getAllSpecificationPhraseItem in interface SpecificationPhraseService

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
public SpecificationPhraseItemByKeyFluentHelper getSpecificationPhraseItemByKey(String specPhraseItemInternalID,
                                                                                         String specPhraseItemChgIntID)

Description copied from interface: SpecificationPhraseService

Fetch a single SpecificationPhraseItem entity using key fields.

Specified by:

getSpecificationPhraseItemByKey in interface SpecificationPhraseService

Parameters:

specPhraseItemInternalID - Phrase Item Internal ID

Constraints: Not nullable, Maximum length: 20

specPhraseItemChgIntID - Phrase Item Change State

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
public SpecificationPhraseSetFluentHelper getAllSpecificationPhraseSet()

Description copied from interface: SpecificationPhraseService

Fetch multiple SpecificationPhraseSet entities.

Specified by:

getAllSpecificationPhraseSet in interface SpecificationPhraseService

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
public SpecificationPhraseSetByKeyFluentHelper getSpecificationPhraseSetByKey(String specPhraseSetInternalID,
                                                                                       String specPhraseSetChgIntID)

Description copied from interface: SpecificationPhraseService

Fetch a single SpecificationPhraseSet entity using key fields.

Specified by:

getSpecificationPhraseSetByKey in interface SpecificationPhraseService

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
public SpecificationPhraseSetTextFluentHelper getAllSpecificationPhraseSetText()

Description copied from interface: SpecificationPhraseService

Fetch multiple SpecificationPhraseSetText entities.

Specified by:

getAllSpecificationPhraseSetText in interface SpecificationPhraseService

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
public SpecificationPhraseSetTextByKeyFluentHelper getSpecificationPhraseSetTextByKey(String specPhraseSetDescIntID,
                                                                                               String specPhraseSetDescChgIntID)

Description copied from interface: SpecificationPhraseService

Fetch a single SpecificationPhraseSetText entity using key fields.

Specified by:

getSpecificationPhraseSetTextByKey in interface SpecificationPhraseService

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
public SpecPhraseSetPhraseAssgmtFluentHelper getAllSpecPhraseSetPhraseAssgmt()

Description copied from interface: SpecificationPhraseService

Fetch multiple SpecPhraseSetPhraseAssgmt entities.

Specified by:

getAllSpecPhraseSetPhraseAssgmt in interface SpecificationPhraseService

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
public SpecPhraseSetPhraseAssgmtByKeyFluentHelper getSpecPhraseSetPhraseAssgmtByKey(String specPhraseAssgmtInternalID,
                                                                                             String specPhraseAssgmtChgIntID)

Description copied from interface: SpecificationPhraseService

Fetch a single SpecPhraseSetPhraseAssgmt entity using key fields.

Specified by:

getSpecPhraseSetPhraseAssgmtByKey in interface SpecificationPhraseService

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.