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

Class DefaultBusinessPlaceService

java.lang.Object

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

All Implemented Interfaces:

BatchService<BusinessPlaceServiceBatch>, BusinessPlaceService

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

This service provides queries about business places based on countries/regions or scenarios. The detailed information you can query is as follows: - Enablement status of a business place in the current business scenario. Based on the enablement status, customers can decide the field status of the business place on the UI, which can be invisible, display only, optional or mandatory. - List of business places by input variants. - Detailed information about business places, such as tax registration number and address. - Attributes of country/region-specific business places..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_GLO_BUSINESSPLACE_SRV
API Version:	1
Communication Scenario:	Business Place Integration (SAP_COM_0394)
Scope Items:	Accounting and Financial Close (J58), Accounts Receivable (J59), Accounts Payable (J60)
Authentication Methods:	Basic, x509
Business Object:	BusinessPlace

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultBusinessPlaceService() Creates a service using BusinessPlaceService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultBusinessPlaceServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
BusinessPlaceFluentHelper	getAllBusinessPlace() Fetch multiple BusinessPlace entities.
BusinessPlaceByKeyFluentHelper	getBusinessPlaceByKey(String companyCode, String businessPlaceID) Fetch a single BusinessPlace entity using key fields.
GetBusinessPlaceFieldPropertiesFluentHelper	getBusinessPlaceFieldProperties(String scenarioID, String companyCode) Creates a fluent helper for the GetBusinessPlaceFieldProperties OData function import.
DefaultBusinessPlaceService	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

DefaultBusinessPlaceService

public DefaultBusinessPlaceService()

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

Method Detail

withServicePath

@Nonnull
public DefaultBusinessPlaceService withServicePath(@Nonnull
                                                            String servicePath)

Description copied from interface: BusinessPlaceService

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 BusinessPlaceService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultBusinessPlaceServiceBatch batch()

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

Specified by:

batch in interface BatchService<BusinessPlaceServiceBatch>

Returns:

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

getAllBusinessPlace

@Nonnull
public BusinessPlaceFluentHelper getAllBusinessPlace()

Description copied from interface: BusinessPlaceService

Fetch multiple BusinessPlace entities.

Specified by:

getAllBusinessPlace in interface BusinessPlaceService

Returns:

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

getBusinessPlaceByKey

@Nonnull
public BusinessPlaceByKeyFluentHelper getBusinessPlaceByKey(String companyCode,
                                                                     String businessPlaceID)

Description copied from interface: BusinessPlaceService

Fetch a single BusinessPlace entity using key fields.

Specified by:

getBusinessPlaceByKey in interface BusinessPlaceService

Parameters:

companyCode - The company code is an organizational unit within financial accounting.

Constraints: Not nullable, Maximum length: 4

businessPlaceID - Specifies the business place.

Constraints: Not nullable, Maximum length: 4

Returns:

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

getBusinessPlaceFieldProperties

@Nonnull
public GetBusinessPlaceFieldPropertiesFluentHelper getBusinessPlaceFieldProperties(@Nonnull
                                                                                            String scenarioID,
                                                                                            @Nonnull
                                                                                            String companyCode)

Description copied from interface: BusinessPlaceService

Creates a fluent helper for the GetBusinessPlaceFieldProperties OData function import.

Specified by:

getBusinessPlaceFieldProperties in interface BusinessPlaceService

Parameters:

scenarioID - Constraints: Not nullable, Maximum length: 6

Original parameter name from the Odata EDM: ScenarioID

companyCode - Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: CompanyCode

Returns:

A fluent helper object that will execute the GetBusinessPlaceFieldProperties OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.