Interface Currency

All Superinterfaces:

Comparable<Currency>, Currency, OsidPrimitive, OsidPrimitive, Serializable

public interface Currency
extends OsidPrimitive, Currency

This primitive represents a currency amount.

Method Summary

Modifier and Type	Method	Description
BigDecimal	getAmount()	Gets the total amount.
Type	getCurrencyType()	Gets the currency type.

Methods inherited from interface Currency

compareTo, equals, hashCode, isLarger, isSmaller

Modifier and Type	Method	Description
int	compareTo(Currency currency)	Compares this currency with the specified Currency for order.
boolean	equals(Object obj)	Determines if the given Currency is equal to this one.
int	hashCode()	Returns a hash code value for this Currency.
boolean	isLarger(Currency currency)	Tests if this Currency is greater than the given Currency.
boolean	isSmaller(Currency currency)	Tests if this Currency is less than the given Currency.

Methods inherited from interface OsidPrimitive

toString

Modifier and Type	Method	Description
String	toString()	Returns a string representation of this OsidPrimitive.

Method Details

getCurrencyType

Type getCurrencyType()

Gets the currency type.

Returns:

the currency type

Compliance:

mandatory - This method must be implemented.

getAmount

BigDecimal getAmount()

Gets the total amount.

Returns:

the amount

Compliance:

mandatory - This method must be implemented.