GeoSoft API

no.geosoft.cc.currency
Class CurrencyManager

Object
  |
  +--CurrencyManager

public class CurrencyManager
extends Object

A currency manager object. The client machine must be online in order for dynamic exchange rates to work.

Author:
GeoSoft

Constructor Summary
CurrencyManager()
          Create a currency manager with default currency server.
CurrencyManager(CurrencyServer currencyServer)
          Create currency manager with the specified currency server.
 
Method Summary
 void addCurrencyListener(CurrencyListener currencyListener)
          Add a display currency listener.
 double convert(double amount, Currency fromCurrency, Currency toCurrency)
          Convert an amount between two currencies.
 double convertFromBase(double amount, Currency currency)
          Convert an amount in base currency (US$) to the given currency.
 double convertToBase(double amount, Currency currency)
          Convert an amount in a given currency to base currency (US$).
 double getBaseAmount(double amount)
          Convert an amount in current display currency to base currency (US$).
 Currency getCurrency(String isoCode)
          Get currency for specified ISO code.
 double getDisplayAmount(double amount)
          Convert a base amount (US$) to current display currency.
 Currency getDisplayCurrency()
          Get current "display currency".
static void main(String[] args)
          Testing this class.
 void removeCurrencyListener(CurrencyListener currencyListener)
          Remove a display currency listener.
 void setDisplayCurrency(Currency currency)
          Set the current "display currency".
 
Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CurrencyManager

public CurrencyManager()
Create a currency manager with default currency server.


CurrencyManager

public CurrencyManager(CurrencyServer currencyServer)
Create currency manager with the specified currency server.

Parameters:
currencyServer - Currency server.
Method Detail

setDisplayCurrency

public void setDisplayCurrency(Currency currency)
Set the current "display currency". The "dipslay currency" feature is optional, but useful for GUI clients that display money amounts in a user defined currency.

Parameters:
currency - New display currency.
See Also:
addCurrencyListener(no.geosoft.cc.currency.CurrencyListener)

getDisplayCurrency

public Currency getDisplayCurrency()
Get current "display currency".

Returns:
Current display currency.

getCurrency

public Currency getCurrency(String isoCode)
Get currency for specified ISO code. The present currency server defines which currencies are defined.

Parameters:
isoCode - ISO code of currency to get.
Returns:
Requested currency (or null if not supported by the current currency server.

convertToBase

public double convertToBase(double amount,
                            Currency currency)
Convert an amount in a given currency to base currency (US$).

Parameters:
amount - Amount to covert.
currency - Currency to convert from.
Returns:
Equivalent in base currency (US$) according to exchange rates given by current currency server.

getBaseAmount

public double getBaseAmount(double amount)
Convert an amount in current display currency to base currency (US$).

Parameters:
amount - Amount to covert.
Returns:
Equivalent in base currency (US$) according to exchange rates given by current currency server.

convertFromBase

public double convertFromBase(double amount,
                              Currency currency)
Convert an amount in base currency (US$) to the given currency.

Parameters:
amount - Amount to covert.
currency - Currency to convert to.
Returns:
Equivalent in given currency according to exchange rates given by current currency server.

getDisplayAmount

public double getDisplayAmount(double amount)
Convert a base amount (US$) to current display currency.

Parameters:
amount - Amount to covert.
Returns:
Equivalent in display currency according to exchange rates given by current currency server.

convert

public double convert(double amount,
                      Currency fromCurrency,
                      Currency toCurrency)
Convert an amount between two currencies.

Parameters:
amount - Amount to convert.
fromCurrency - Currency to convert from.
toCurrency - Currency to convert to.
Returns:
Converted amount according to exchange rates given by current currency server.

addCurrencyListener

public void addCurrencyListener(CurrencyListener currencyListener)
Add a display currency listener. The listener is notified when the display currency changes.

Parameters:
currencyListener - Listener to add.

removeCurrencyListener

public void removeCurrencyListener(CurrencyListener currencyListener)
Remove a display currency listener.

Parameters:
currencyListener - Listener to remove.

main

public static void main(String[] args)
Testing this class.

Parameters:
args - Not used.

GeoSoft API

Copyright © 2004 - Geotechnical Software Services     geosoft.no