senselogic.sitevision.api.i18n

Interface Currency

public interface Currency

Representation of a currency.

This interface is conceptually equivalent with the java.util.Currency class.

An instance of the Sitevision class implementing this interface is obtained via CurrencyFactory.

Since:

Sitevision 6.1

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
String	getCurrencyCode() Gets the ISO 4217 currency code of this currency.
String	getDisplayName(Locale aLocale) Gets the name that is suitable for displaying this currency for a specified locale.
String	getSymbol(Locale aLocale) Gets the symbol of this currency for a specified locale.

Method Detail

getCurrencyCode

String getCurrencyCode()

Gets the ISO 4217 currency code of this currency.

Currency codes are specified with a three-letter alphabetic code specified by ISO 4217

Common currencies

Currency name	Currency code
US Dollar	USD
Euro	EUR
Brittish Pound	GBP
Swedish Krona	SEK
Norwegian Krone	NOK

Returns:

the ISO 4217 currency code of this currency.

getDisplayName

String getDisplayName(Locale aLocale)
               throws NullPointerException

Gets the name that is suitable for displaying this currency for a specified locale. If there is no suitable display name found for the specified locale, the ISO 4217 currency code is returned.

Parameters:

aLocale - the locale to use for display of this currency

Returns:

the display name of this currency for aLocale

Throws:

NullPointerException - if aLocale is null

getSymbol

String getSymbol(Locale aLocale)
          throws NullPointerException

Gets the symbol of this currency for a specified locale. For example, for the US Dollar, the symbol is "$" if the specified locale is the US, while for other locales it may be "US$". If no symbol can be determined, the ISO 4217 currency code is returned.

Parameters:

aLocale - the locale to use for display of the symbol of this currency

Returns:

the symbol of this currency for aLocale

Throws:

NullPointerException - if aLocale is null