com.sap.cloud.sdk.services.currencyconversion.datamodel.adapter

Interface DataAdapter

public interface DataAdapter

An interface with the method signatures to get exchange rates, exchange rate type details and default tenant settings. You must provide an implementation of this interface when calling the non-fixed rate Conversion APIs. This enables the library to fetch the relevant ExchangeRate, ExchangeRateTypeDetail and TenantSettings to perform conversions.

Method Summary

Modifier and Type	Method and Description
default TenantSettings	getDefaultSettingsForTenant(Tenant tenant) Returns the default TenantSettings associated with a Tenant.
default TenantSettings	getDefaultTenantSettings(Tenant tenant) Deprecated. It is a deprecated API. Please use getDefaultSettingsForTenant(Tenant). Returns the default TenantSettings associated with a Tenant.
default List<ExchangeRate>	getExchangeRates(List<ConversionParametersForNonFixedRate> conversionParameters, Tenant tenant, TenantSettings tenantSettings) Deprecated. It is a deprecated API. Please use getExchangeRatesForTenant(List, Tenant, TenantSettings). Returns a list of ExchangeRate to be used for conversion for a given list of ConversionParametersForNonFixedRate. It fetches the exchange rates with the given TenantSettings for a specific Tenant. It is recommended that its implementation provides a minimal response so that the conversion process is optimized.
default List<ExchangeRate>	getExchangeRatesForTenant(List<ConversionParametersForNonFixedRate> conversionParameters, Tenant tenant, TenantSettings tenantSettings) Returns a list of ExchangeRate to be used for conversion for a given list of ConversionParametersForNonFixedRate.
default Map<RateType,ExchangeRateTypeDetail>	getExchangeRateTypeDetails(Set<RateType> rateTypeSet) Deprecated. It is a deprecated API. Please use getExchangeRateTypeDetailsForTenant(Tenant, Set). Returns the Map of the ExchangeRateTypeDetail with the RateType as the key for a given Set of RateType. It fetches the details of the given rate types. Based on that the details, we can determine if the inversion is allowed for the rate type and if there is any reference currency specified for the rate type.
default Map<RateType,ExchangeRateTypeDetail>	getExchangeRateTypeDetailsForTenant(Tenant tenant, Set<RateType> rateTypeSet) Returns the Map of the ExchangeRateTypeDetail with the RateType as the key for a given Set of RateType.

Method Detail

getExchangeRatesForTenant

@Nullable
default List<ExchangeRate> getExchangeRatesForTenant(@Nonnull
                                                               List<ConversionParametersForNonFixedRate> conversionParameters,
                                                               @Nonnull
                                                               Tenant tenant,
                                                               @Nullable
                                                               TenantSettings tenantSettings)
                                                        throws DataAdapterException

Returns a list of ExchangeRate to be used for conversion for a given list of ConversionParametersForNonFixedRate. It fetches the exchange rates with the given TenantSettings for a specific Tenant. It is recommended that its implementation provides a minimal response so that the conversion process is optimized.

Parameters:

conversionParameters - The ConversionParametersForNonFixedRate to fetch the relevant exchange rates.

tenant - The Tenant for which the conversion is requested.

tenantSettings - The TenantSettings to fetch the relevant exchange rates.

Returns:

The list of ExchangeRate.

Throws:

DataAdapterException - An exception that occurs when none of the requested conversions could be processed.

getExchangeRates

@Deprecated
 @Nullable
default List<ExchangeRate> getExchangeRates(@Nonnull
                                                                   List<ConversionParametersForNonFixedRate> conversionParameters,
                                                                   @Nonnull
                                                                   Tenant tenant,
                                                                   @Nullable
                                                                   TenantSettings tenantSettings)
                                                            throws DataAdapterException

Deprecated. It is a deprecated API. Please use getExchangeRatesForTenant(List, Tenant, TenantSettings).

Returns a list of ExchangeRate to be used for conversion for a given list of ConversionParametersForNonFixedRate. It fetches the exchange rates with the given TenantSettings for a specific Tenant. It is recommended that its implementation provides a minimal response so that the conversion process is optimized.

Parameters:

conversionParameters - The ConversionParametersForNonFixedRate to fetch the relevant exchange rates.

tenant - The Tenant for which the conversion is requested.

tenantSettings - The TenantSettings to fetch the relevant exchange rates.

Returns:

The list of ExchangeRate.

Throws:

DataAdapterException - An exception that occurs when none of the requested conversions could be processed.

getDefaultSettingsForTenant

@Nullable
default TenantSettings getDefaultSettingsForTenant(@Nonnull
                                                             Tenant tenant)
                                                      throws DataAdapterException

Returns the default TenantSettings associated with a Tenant.

Parameters:

tenant - The Tenant for which the conversion is requested.

Returns:

The default TenantSettings for the given Tenant.

Throws:

DataAdapterException - An exception that occurs when none of the requested conversions could be processed.

getDefaultTenantSettings

@Deprecated
 @Nullable
default TenantSettings getDefaultTenantSettings(@Nonnull
                                                                       Tenant tenant)
                                                                throws DataAdapterException

Deprecated. It is a deprecated API. Please use getDefaultSettingsForTenant(Tenant).

Returns the default TenantSettings associated with a Tenant.

Parameters:

tenant - The Tenant for which the conversion is requested.

Returns:

The default TenantSettings for the given Tenant.

Throws:

DataAdapterException - An exception that occurs when none of the requested conversions could be processed.

getExchangeRateTypeDetailsForTenant

@Nullable
default Map<RateType,ExchangeRateTypeDetail> getExchangeRateTypeDetailsForTenant(@Nonnull
                                                                                           Tenant tenant,
                                                                                           @Nonnull
                                                                                           Set<RateType> rateTypeSet)
                                                                                    throws DataAdapterException

Returns the Map of the ExchangeRateTypeDetail with the RateType as the key for a given Set of RateType. It fetches the details of the given rate types. Based on that the details, we can determine if the inversion is allowed for the rate type and if there is any reference currency specified for the rate type.

Parameters:

tenant - The Tenant for which the exchange rate type details is requested.

rateTypeSet - The Set of RateType used to fetch the relevant exchange rate type details.

Returns:

The Map of the ExchangeRateTypeDetail with the RateType as the key.

Throws:

DataAdapterException - An exception that occurs when none of the requested conversions could be processed.

getExchangeRateTypeDetails

@Deprecated
 @Nullable
default Map<RateType,ExchangeRateTypeDetail> getExchangeRateTypeDetails(@Nonnull
                                                                                               Set<RateType> rateTypeSet)
                                                                                        throws DataAdapterException

Deprecated. It is a deprecated API. Please use getExchangeRateTypeDetailsForTenant(Tenant, Set).

Returns the Map of the ExchangeRateTypeDetail with the RateType as the key for a given Set of RateType. It fetches the details of the given rate types. Based on that the details, we can determine if the inversion is allowed for the rate type and if there is any reference currency specified for the rate type.

Parameters:

rateTypeSet - The Set of RateType used to fetch the relevant exchange rate type details.

Returns:

The Map of the ExchangeRateTypeDetail with the RateType as the key.

Throws:

DataAdapterException - An exception that occurs when none of the requested conversions could be processed.