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

Interface CountryOrRegionService

All Superinterfaces:

BatchService<CountryOrRegionServiceBatch>

All Known Implementing Classes:

DefaultCountryOrRegionService

public interface CountryOrRegionService
extends BatchService<CountryOrRegionServiceBatch>

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

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
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.
CountryOrRegionService	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.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
CountryOrRegionService 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.

getAllCountry

@Nonnull
CountryFluentHelper getAllCountry()

Fetch multiple Country entities.

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
CountryByKeyFluentHelper getCountryByKey(String country)

Fetch a single Country entity using key fields.

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
CountryTextFluentHelper getAllCountryText()

Fetch multiple CountryText entities.

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
CountryTextByKeyFluentHelper getCountryTextByKey(String country,
                                                          String language)

Fetch a single CountryText entity using key fields.

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.