CurrencyConversionApi (Kill Bill apis 0.54.0 API)

All Superinterfaces:: KillbillApi

public interface CurrencyConversionApi
extends KillbillApi

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Set<Currency>`	`getBaseRates()`
`CurrencyConversion`	`getCurrencyConversion(Currency baseCurrency, org.joda.time.DateTime dateConversion)`
`CurrencyConversion`	`getCurrentCurrencyConversion(Currency baseCurrency)`	This will return the latest -- as known by the plugin -- information for the conversion rates.

- Method Detail
  - getBaseRates
```
Set<Currency> getBaseRates()
                    throws CurrencyConversionException
```
    Returns:
    
    the list of currency that can be used as a base currency for conversion
    
    Throws:
    
    CurrencyConversionException - if there is no currency provider
  - getCurrentCurrencyConversion
```
CurrencyConversion getCurrentCurrencyConversion(Currency baseCurrency)
                                         throws CurrencyConversionException
```
    This will return the latest -- as known by the plugin -- information for the conversion rates.
    
    Parameters:
    
    baseCurrency - the base currency to be used
    
    Returns:
    
    the currency list of currency conversion rates
    
    Throws:
    
    CurrencyConversionException - if baseCurrency is not supported or if there is no currency provider
  - getCurrencyConversion
```
CurrencyConversion getCurrencyConversion(Currency baseCurrency,
                                         org.joda.time.DateTime dateConversion)
                                  throws CurrencyConversionException
```
    Parameters:
    
    baseCurrency - the base currency to be used
    
    dateConversion - the date for the conversion
    
    Returns:
    
    the list of currency conversion rates for the date provided
    
    Throws:
    
    CurrencyConversionException - if baseCurrency is not supported or if there is no currency provider