Script: Class dw.util.Currency

Class Currency

Represents a currency supported by the system.

Properties

currencyCode : String Read Only

Gets the ISO 4217 mnemonic currency code of this currency.

defaultFractionDigits : Number Read Only

Gets the default number of fraction digits used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it's 0.

name : String Read Only

Gets a long name for this currency. e.g. "United States Dollar". The returned name is the one stored in the system for this currency. Currently only English names are available, but in the future this method may return a locale-specific name.

symbol : String Read Only

Gets the symbol of this currency. e.g. "$" for the US Dollar.

Constructor Summary

This class does not have a constructor, so you cannot create it directly.

Method Summary

static getCurrency(currencyCode : String) : Currency

Returns a Currency instance for the given currency code, or null if there is no such currency.

getCurrencyCode() : String

Gets the ISO 4217 mnemonic currency code of this currency.

getDefaultFractionDigits() : Number

Gets the default number of fraction digits used with this currency.

getName() : String

Gets a long name for this currency.

getSymbol() : String

Gets the symbol of this currency.

toString() : String

Returns the ISO 4217 mnemonic currency code of this currency.

Methods inherited from class Object

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Method Detail

getCurrency

static getCurrency(currencyCode : String) : Currency

Returns a Currency instance for the given currency code, or null if there is no such currency.

Parameters:

currencyCode - the ISO 4217 mnemonic code of the currency.

Returns:

the Currency instance for the given currency code.

getCurrencyCode

getCurrencyCode() : String

Gets the ISO 4217 mnemonic currency code of this currency.

Returns:

the ISO 4217 mnemonic currency code of this currency.


getDefaultFractionDigits

getDefaultFractionDigits() : Number

Gets the default number of fraction digits used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it's 0.

Returns:

the default number of fraction digits used with this currency.


getName

getName() : String

Gets a long name for this currency. e.g. "United States Dollar". The returned name is the one stored in the system for this currency. Currently only English names are available, but in the future this method may return a locale-specific name.

Returns:

a long name for this currency. e.g. "United States Dollar".


getSymbol

getSymbol() : String

Gets the symbol of this currency. e.g. "$" for the US Dollar.

Returns:

the symbol of this currency.


toString

toString() : String

Returns the ISO 4217 mnemonic currency code of this currency.

Returns:

the ISO 4217 mnemonic currency code of this currency.