com.konakart.blif

Interface CurrencyMgrIf

All Known Implementing Classes:

CurrencyMgr

public interface CurrencyMgrIf

CurrencyMgrIf Interface which an implementation of this manager must adhere to.

Method Summary

Modifier and Type	Method and Description
Currency	fetchDefaultCurrency() The default currency is referenced by a configuration variable called DEFAULT_CURRENCY.
java.lang.String	formatPrice(java.math.BigDecimal number, java.lang.String currencyCode) Used to create a string in order to visualise a price.
Currency[]	getCurrencies() This returns an array of currencies for all of the currencies in the currency table.
Currency	getCurrency(java.lang.String currencyCode) Returns the currency referenced by the currencyCode.
Currency	getDefaultCurrency() Returns the default currency from the cache.
java.text.DecimalFormat	getDefaultCurrencyFormatter() Gets the formatter for the default currency
int	getDefaultCurrencyScale() A utility method to return the scale of the default currency used in price calculations
void	refreshConfigs() Refresh the configuration of the currency manager

Method Detail

getDefaultCurrency

Currency getDefaultCurrency()
                     throws org.apache.torque.TorqueException,
                            com.konakart.app.KKException,
                            com.workingdogs.village.DataSetException

Returns the default currency from the cache.

Returns:

Returns the default currency object

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

fetchDefaultCurrency

Currency fetchDefaultCurrency()
                       throws java.lang.Exception

The default currency is referenced by a configuration variable called DEFAULT_CURRENCY. If this isn't found then we return the currency in the currency table with the lowest id. Once found, the default currency is cached.

Returns:

Returns a currency

Throws:

java.lang.Exception - an unexpected exception

getDefaultCurrencyFormatter

java.text.DecimalFormat getDefaultCurrencyFormatter()
                                             throws org.apache.torque.TorqueException,
                                                    com.konakart.app.KKException,
                                                    com.workingdogs.village.DataSetException

Gets the formatter for the default currency

Returns:

Default currency formatter

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

getCurrency

Currency getCurrency(java.lang.String currencyCode)
              throws com.konakart.app.KKException,
                     org.apache.torque.TorqueException,
                     com.workingdogs.village.DataSetException

Returns the currency referenced by the currencyCode.

Parameters:

currencyCode - the currencyCode

Returns:

Returns a currency

Throws:

com.konakart.app.KKException - an unexpected KKException exception

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getCurrencies

Currency[] getCurrencies()
                  throws org.apache.torque.TorqueException,
                         com.workingdogs.village.DataSetException

This returns an array of currencies for all of the currencies in the currency table.

Returns:

Returns an array of currencies

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

formatPrice

java.lang.String formatPrice(java.math.BigDecimal number,
                             java.lang.String currencyCode)
                      throws com.konakart.app.KKException,
                             org.apache.torque.TorqueException,
                             com.workingdogs.village.DataSetException

Used to create a string in order to visualise a price. It ensures that the decimal places, the thousands separator and the currency symbol are correct.

Parameters:

number - the number

currencyCode - the currencyCode

Returns:

The formatted price

Throws:

com.konakart.app.KKException - an unexpected KKException exception

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Refresh the configuration of the currency manager

Throws:

java.lang.Exception - an unexpected exception

getDefaultCurrencyScale

int getDefaultCurrencyScale()
                     throws com.konakart.app.KKException,
                            org.apache.torque.TorqueException,
                            com.workingdogs.village.DataSetException

A utility method to return the scale of the default currency used in price calculations

Returns:

Returns the scale of the default currency

Throws:

com.konakart.app.KKException - an unexpected KKException exception

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)