IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.bc.fx
Interface RatesProvider

All Known Implementing Classes:
AbstractRatesProvider, CachedRatesProvider, RatesProviderImpl

public interface RatesProvider

The common interface for RateProvider classes.


Method Summary
 java.util.Set<java.lang.String> getAllSupportedCurrencies()
          Returns all supported currency codes in a Set.
 java.util.Set<java.lang.String> getDefinedMonetaryItems()
          Returns all defined monetary item types.
 java.math.BigDecimal getRate(RatesQueryRequest request, boolean isBuy)
          Returns the rate at which the financial institution buys or sells the destination currency.
 

Method Detail

getRate

java.math.BigDecimal getRate(RatesQueryRequest request,
                             boolean isBuy)
                             throws ForeignExchangeException
Returns the rate at which the financial institution buys or sells the destination currency.

Parameters:
request - the RatesQueryRequest instance specifying the information of the query
isBuy - true if the requested rate is a buy rate, otherwise it should be false
Returns:
the rate at which the financial institution buys or sells the destination currency.
Throws:
ForeignExchangeException - occurs if there is an error accessing the rate

getAllSupportedCurrencies

java.util.Set<java.lang.String> getAllSupportedCurrencies()
                                                          throws ForeignExchangeException
Returns all supported currency codes in a Set.

Returns:
the Set containing all supported currency codes
Throws:
ForeignExchangeException - occurs if there is an error accessing the Set

getDefinedMonetaryItems

java.util.Set<java.lang.String> getDefinedMonetaryItems()
                                                        throws ForeignExchangeException
Returns all defined monetary item types.

Returns:
the Set containing all supported monetary item types
Throws:
ForeignExchangeException - occurs if there is an error accessing the Set

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2010