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

Interface BusinessAreaService

All Superinterfaces:

BatchService<BusinessAreaServiceBatch>

All Known Implementing Classes:

DefaultBusinessAreaService

public interface BusinessAreaService
extends BatchService<BusinessAreaServiceBatch>

This service enables you to read business area master data in an API call. It is based on the OData protocol, and can be consumed in Fiori apps and on other user interfaces.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_BUSINESSAREA_SRV
API Version:	1
Communication Scenario:	SAP Business Objects Cloud for Planning Integration (SAP_COM_0087)
Scope Items:	oData Integration with SAP Business Objects Cloud for Planning (1YB)

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
BusinessAreaFluentHelper	getAllBusinessArea() Fetch multiple BusinessArea entities.
BusinessAreaTextFluentHelper	getAllBusinessAreaText() Fetch multiple BusinessAreaText entities.
BusinessAreaByKeyFluentHelper	getBusinessAreaByKey(String businessArea) Fetch a single BusinessArea entity using key fields.
BusinessAreaTextByKeyFluentHelper	getBusinessAreaTextByKey(String businessArea, String language) Fetch a single BusinessAreaText entity using key fields.
BusinessAreaService	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.s4hana.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
BusinessAreaService 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.

getAllBusinessArea

@Nonnull
BusinessAreaFluentHelper getAllBusinessArea()

Fetch multiple BusinessArea entities.

Returns:

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

getBusinessAreaByKey

@Nonnull
BusinessAreaByKeyFluentHelper getBusinessAreaByKey(String businessArea)

Fetch a single BusinessArea entity using key fields.

Parameters:

businessArea - Key that uniquely identifies a business area.

Constraints: Not nullable, Maximum length: 4

Returns:

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

getAllBusinessAreaText

@Nonnull
BusinessAreaTextFluentHelper getAllBusinessAreaText()

Fetch multiple BusinessAreaText entities.

Returns:

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

getBusinessAreaTextByKey

@Nonnull
BusinessAreaTextByKeyFluentHelper getBusinessAreaTextByKey(String businessArea,
                                                                    String language)

Fetch a single BusinessAreaText entity using key fields.

Parameters:

businessArea - Key that uniquely identifies a business area.

Constraints: Not nullable, Maximum length: 4

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

Returns:

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