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

Class DefaultFunctionalAreaService

java.lang.Object

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

All Implemented Interfaces:

BatchService<FunctionalAreaServiceBatch>, FunctionalAreaService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultFunctionalAreaService")
public class DefaultFunctionalAreaService
extends Object
implements FunctionalAreaService

The service contains functional area and functional area text nodes.

Business Documentation

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:	Import Connection setup with SAP Analytics Cloud (1YB)
Authentication Methods:	Basic, x509

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.FunctionalAreaService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultFunctionalAreaService() Creates a service using FunctionalAreaService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

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

DefaultFunctionalAreaService

public DefaultFunctionalAreaService()

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

Method Detail

withServicePath

@Nonnull
public DefaultFunctionalAreaService withServicePath(@Nonnull
                                                             String servicePath)

Description copied from interface: FunctionalAreaService

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 FunctionalAreaService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultFunctionalAreaServiceBatch batch()

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

Specified by:

batch in interface BatchService<FunctionalAreaServiceBatch>

Returns:

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

getAllFunctionalArea

@Nonnull
public FunctionalAreaFluentHelper getAllFunctionalArea()

Description copied from interface: FunctionalAreaService

Fetch multiple FunctionalArea entities.

Specified by:

getAllFunctionalArea in interface FunctionalAreaService

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
public FunctionalAreaByKeyFluentHelper getFunctionalAreaByKey(String functionalArea)

Description copied from interface: FunctionalAreaService

Fetch a single FunctionalArea entity using key fields.

Specified by:

getFunctionalAreaByKey in interface FunctionalAreaService

Parameters:

functionalArea - Structure criterion for an enterprise or government based on functional aspects.

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
public FunctionalAreaTextFluentHelper getAllFunctionalAreaText()

Description copied from interface: FunctionalAreaService

Fetch multiple FunctionalAreaText entities.

Specified by:

getAllFunctionalAreaText in interface FunctionalAreaService

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
public FunctionalAreaTextByKeyFluentHelper getFunctionalAreaTextByKey(String language,
                                                                               String functionalArea)

Description copied from interface: FunctionalAreaService

Fetch a single FunctionalAreaText entity using key fields.

Specified by:

getFunctionalAreaTextByKey in interface FunctionalAreaService

Parameters:

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

functionalArea - Structure criterion for an enterprise or government based on functional aspects.

Constraints: Not nullable, Maximum length: 16

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.