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

Interface CountryService

All Superinterfaces:

BatchService<CountryServiceBatch>

All Known Implementing Classes:

DefaultCountryService

public interface CountryService
extends BatchService<CountryServiceBatch>

This service enables you to read country 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_COUNTRY_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
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.
CountryService	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
CountryService 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 - Here you specify the country key for the customer or vendor.

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 - The country key contains information which the system uses to check entries such as the length of the postal code or bank account number.

Constraints: Not nullable, Maximum length: 3

language - The language key indicates

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.