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

Class DefaultCountryOrRegionService

java.lang.Object

com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.DefaultCountryOrRegionService

All Implemented Interfaces:

BatchService<CountryOrRegionServiceBatch>, CountryOrRegionService

@Named(value="com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.DefaultCountryOrRegionService")
public class DefaultCountryOrRegionService
extends Object
implements CountryOrRegionService

The service enables you to retrieve country/region master data. It contains header and nodes with business information. You can read country/region information like ISO codes, currencies and tax procedure..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_COUNTRY_SRV
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.CountryOrRegionService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultCountryOrRegionService() Creates a service using CountryOrRegionService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultCountryOrRegionServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
CountryFluentHelper	getAllCountry() Fetch multiple Country entities.
CountryTextFluentHelper	getAllCountryText() Fetch multiple CountryText entities.
CountryByKeyFluentHelper	getCountryByKey(String country) Fetch a single Country entity using key fields.
CountryTextByKeyFluentHelper	getCountryTextByKey(String country, String language) Fetch a single CountryText entity using key fields.
DefaultCountryOrRegionService	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

DefaultCountryOrRegionService

public DefaultCountryOrRegionService()

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

Method Detail

withServicePath

@Nonnull
public DefaultCountryOrRegionService withServicePath(@Nonnull
                                                              String servicePath)

Description copied from interface: CountryOrRegionService

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 CountryOrRegionService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultCountryOrRegionServiceBatch batch()

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

Specified by:

batch in interface BatchService<CountryOrRegionServiceBatch>

Returns:

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

getAllCountry

@Nonnull
public CountryFluentHelper getAllCountry()

Description copied from interface: CountryOrRegionService

Fetch multiple Country entities.

Specified by:

getAllCountry in interface CountryOrRegionService

Returns:

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

getCountryByKey

@Nonnull
public CountryByKeyFluentHelper getCountryByKey(String country)

Description copied from interface: CountryOrRegionService

Fetch a single Country entity using key fields.

Specified by:

getCountryByKey in interface CountryOrRegionService

Parameters:

country - Country Key

Constraints: Not nullable, Maximum length: 3

Returns:

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

getAllCountryText

@Nonnull
public CountryTextFluentHelper getAllCountryText()

Description copied from interface: CountryOrRegionService

Fetch multiple CountryText entities.

Specified by:

getAllCountryText in interface CountryOrRegionService

Returns:

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

getCountryTextByKey

@Nonnull
public CountryTextByKeyFluentHelper getCountryTextByKey(String country,
                                                                 String language)

Description copied from interface: CountryOrRegionService

Fetch a single CountryText entity using key fields.

Specified by:

getCountryTextByKey in interface CountryOrRegionService

Parameters:

country - Country Key

Constraints: Not nullable, Maximum length: 3

language - Language Key

Constraints: Not nullable, Maximum length: 2

Returns:

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