org.posper.hibernate

Class Currency

java.lang.Object

org.posper.hibernate.AbstractHibernateObject<Type>

org.posper.hibernate.AbstractIdentifiedHibernateObject<Currency>

org.posper.hibernate.Currency

All Implemented Interfaces:

Serializable

public class Currency
extends AbstractIdentifiedHibernateObject<Currency>

This entity defines currencies that can be used for payment additionally to the base currency defined by the region setting.

Author:

Hans

See Also:

Serialized Form

Field Summary

Fields inherited from class org.posper.hibernate.AbstractIdentifiedHibernateObject

id

Constructor Summary

Constructors

Constructor and Description
Currency() Create a new instance of Currency

Method Summary

Modifier and Type	Method and Description
Double	convertToForeign(Double value) Convert the currency defined through the locale settings to ths currency
Double	convertToLocal(Double value) Convert the valie from the foreign currency to the local currency
String	format(Double value) Return a currency formatted string with the user defined symbol.
Double	getConversion_rate() POSper uses 'direct quotation': the conversion rate is the price of a foreign currency unit in the base currency.
String	getCurrency_code() As currency code the 3 character ISO representation should be used.
String	getSymbol() Get the user defined symbol for this currency.
void	setConversion_rate(Double conversion_rate) Set the conversion rate in direct quotation.
void	setCurrency_code(String currency_code) Set the currency code.
void	setSymbol(String symbol) Set a user defined currency symbol.
String	toString()

Methods inherited from class org.posper.hibernate.AbstractIdentifiedHibernateObject

equals, getId, getVersion, hashCode, setId, setVersion

Methods inherited from class org.posper.hibernate.AbstractHibernateObject

delete, getGetters, getKeyValue, merge, refresh, save

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Currency

public Currency()

Create a new instance of Currency

Method Detail

getConversion_rate

public Double getConversion_rate()

POSper uses 'direct quotation': the conversion rate is the price of a foreign currency unit in the base currency.

Returns:

the conversion rate as Double

setConversion_rate

public void setConversion_rate(Double conversion_rate)

Set the conversion rate in direct quotation.

Parameters:

conversion_rate -

getCurrency_code

public String getCurrency_code()

As currency code the 3 character ISO representation should be used.

Returns:

setCurrency_code

public void setCurrency_code(String currency_code)

Set the currency code. POSper stores the code in capital letters. There is no validity check except that the code must be unique.

Parameters:

currency_code -

toString

public String toString()

Overrides:

toString in class Object

getSymbol

public String getSymbol()

Get the user defined symbol for this currency.

Returns:

the currency symbol defined for this currency. If set to null the symbol defined through the locale settins shall e used.

setSymbol

public void setSymbol(String symbol)

Set a user defined currency symbol. This is useful when we deal with foreign currencies where the locale settings would only provide the ISO code.

Parameters:

symbol -

convertToForeign

public Double convertToForeign(Double value)

Convert the currency defined through the locale settings to ths currency

Parameters:

value -

Returns:

the value in the foreign currency

convertToLocal

public Double convertToLocal(Double value)

Convert the valie from the foreign currency to the local currency

Parameters:

value - in foreign currency

Returns:

the value in local currency

format

public String format(Double value)

Return a currency formatted string with the user defined symbol. If the user defined symbol is null. the symbol defined by the locale settings for this currency is used.

Parameters:

value -

Returns: