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

Interface FunctionalAreaService

All Known Implementing Classes:

DefaultFunctionalAreaService

public interface FunctionalAreaService

This service enables you to display functional area master data to be consumed in SAP Fiori apps and on other user interfaces.

https://help.sap.com/viewer/1e3193fd333347c5ad8c0d2e81b60d1b/latest/en-US/9d779144409d43f4b41a6bbcceac86fb.html

Reference: SAP API Business Hub

Details:

OData Service:	API_FUNCTIONALAREA_SRV
API Version:	1
Communication Scenario:	SAP Analytics Cloud for Planning Integration (SAP_COM_0087)
Scope Items:	Integration between SAP S/4HANA Cloud and SAP Analytics Cloud (1YB)
Authentication Methods:	Basic, x509

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
FunctionalAreaFluentHelper	getAllFunctionalArea() Fetch multiple FunctionalArea entities.
FunctionalAreaTextFluentHelper	getAllFunctionalAreaText() Fetch multiple FunctionalAreaText entities.
FunctionalAreaByKeyFluentHelper	getFunctionalAreaByKey(String functionalArea) Fetch a single FunctionalArea entity using key fields.
FunctionalAreaTextByKeyFluentHelper	getFunctionalAreaTextByKey(String language, String functionalArea) Fetch a single FunctionalAreaText entity using key fields.
FunctionalAreaService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

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

FunctionalAreaService 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

getAllFunctionalArea

@Nonnull
FunctionalAreaFluentHelper getAllFunctionalArea()

Fetch multiple FunctionalArea entities.

Returns:

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

getFunctionalAreaByKey

@Nonnull
FunctionalAreaByKeyFluentHelper getFunctionalAreaByKey(String functionalArea)

Fetch a single FunctionalArea entity using key fields.

Parameters:

functionalArea - Functional Area

Constraints: Not nullable, Maximum length: 16

Returns:

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

getAllFunctionalAreaText

@Nonnull
FunctionalAreaTextFluentHelper getAllFunctionalAreaText()

Fetch multiple FunctionalAreaText entities.

Returns:

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

getFunctionalAreaTextByKey

@Nonnull
FunctionalAreaTextByKeyFluentHelper getFunctionalAreaTextByKey(String language,
                                                                        String functionalArea)

Fetch a single FunctionalAreaText entity using key fields.

Parameters:

functionalArea - Functional Area

Constraints: Not nullable, Maximum length: 16

language - Language Key

Constraints: Not nullable, Maximum length: 2

Returns:

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