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

Interface ControllingAreaService

All Known Implementing Classes:

DefaultControllingAreaService

public interface ControllingAreaService

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

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CONTROLLINGAREA_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
ControllingAreaFluentHelper	getAllControllingArea() Fetch multiple ControllingArea entities.
ControllingAreaByKeyFluentHelper	getControllingAreaByKey(String controllingArea) Fetch a single ControllingArea entity using key fields.
ControllingAreaService	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

@Nonnull
ControllingAreaService 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.

getAllControllingArea

@Nonnull
ControllingAreaFluentHelper getAllControllingArea()

Fetch multiple ControllingArea entities.

Returns:

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

getControllingAreaByKey

@Nonnull
ControllingAreaByKeyFluentHelper getControllingAreaByKey(String controllingArea)

Fetch a single ControllingArea entity using key fields.

Parameters:

controllingArea - Controlling Area

Constraints: Not nullable, Maximum length: 4

Returns:

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