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

Class DefaultBusinessAreaService

java.lang.Object

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

All Implemented Interfaces:

BatchService<BusinessAreaServiceBatch>, BusinessAreaService

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

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultBusinessAreaService() Creates a service using BusinessAreaService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

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

DefaultBusinessAreaService

public DefaultBusinessAreaService()

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

Method Detail

withServicePath

@Nonnull
public DefaultBusinessAreaService withServicePath(@Nonnull
                                                           String servicePath)

Description copied from interface: BusinessAreaService

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 BusinessAreaService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultBusinessAreaServiceBatch batch()

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

Specified by:

batch in interface BatchService<BusinessAreaServiceBatch>

Returns:

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

getAllBusinessArea

@Nonnull
public BusinessAreaFluentHelper getAllBusinessArea()

Description copied from interface: BusinessAreaService

Fetch multiple BusinessArea entities.

Specified by:

getAllBusinessArea in interface BusinessAreaService

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
public BusinessAreaByKeyFluentHelper getBusinessAreaByKey(String businessArea)

Description copied from interface: BusinessAreaService

Fetch a single BusinessArea entity using key fields.

Specified by:

getBusinessAreaByKey in interface BusinessAreaService

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
public BusinessAreaTextFluentHelper getAllBusinessAreaText()

Description copied from interface: BusinessAreaService

Fetch multiple BusinessAreaText entities.

Specified by:

getAllBusinessAreaText in interface BusinessAreaService

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
public BusinessAreaTextByKeyFluentHelper getBusinessAreaTextByKey(String businessArea,
                                                                           String language)

Description copied from interface: BusinessAreaService

Fetch a single BusinessAreaText entity using key fields.

Specified by:

getBusinessAreaTextByKey in interface BusinessAreaService

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.