org.kuali.student.r2.common.dto

Class CurrencyAmountInfo

java.lang.Object

org.kuali.student.r2.common.dto.CurrencyAmountInfo

All Implemented Interfaces:

Serializable, CurrencyAmount, HasId, HasMeta, HasPrimaryKey

public class CurrencyAmountInfo
extends Object
implements CurrencyAmount, Serializable

Detailed information about an amount of currency including both the type of units and the quantity.

Since:

Mon Jan 11 15:20:51 PST 2010

Author:

Kamal

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CurrencyAmountInfo() Constructs a new CurrencyAmount.
CurrencyAmountInfo(CurrencyAmount currency) Constructs a new CurrencyAmount from another Currency.

Method Summary

Methods

Modifier and Type	Method and Description
Integer	getCurrencyQuantity() The amount of currency.
String	getCurrencyTypeKey() The kind of units associated with the quantity, such as US Dollars.
String	getId() The system assigned unique id to identify this Object.
MetaInfo	getMeta() Create and last update info for the structure.
void	setCurrencyQuantity(Integer currencyQuantity)
void	setCurrencyTypeKey(String currencyTypeKey)
void	setId(String id)
void	setMeta(MetaInfo metaInfo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CurrencyAmountInfo

public CurrencyAmountInfo()

Constructs a new CurrencyAmount.

CurrencyAmountInfo

public CurrencyAmountInfo(CurrencyAmount currency)

Constructs a new CurrencyAmount from another Currency.

Parameters:

currency - the currency to copy

Method Detail

getId

public String getId()

Description copied from interface: HasId

The system assigned unique id to identify this Object. Could be implemented as as sequence number or as a UUID. Attempts to set this value on creates should result in a ReadOnlyException being thrown An Id:

• An id is used when the actual value is unimportant and can therefore be a large hex value for example
• An id value might be 23b9ca9bd203df902
• An Id is never intended to be used directly by an end user.
• Ids are assumed to be of different values in different KS implementations
• Id values are generated by the service implementations
• Id values are never expected to be used in Configuration or Application code

Specified by:

getId in interface HasId

setId

public void setId(String id)

getCurrencyTypeKey

public String getCurrencyTypeKey()

Description copied from interface: CurrencyAmount

The kind of units associated with the quantity, such as US Dollars.

Specified by:

getCurrencyTypeKey in interface CurrencyAmount

setCurrencyTypeKey

public void setCurrencyTypeKey(String currencyTypeKey)

getCurrencyQuantity

public Integer getCurrencyQuantity()

Description copied from interface: CurrencyAmount

The amount of currency.

Specified by:

getCurrencyQuantity in interface CurrencyAmount

setCurrencyQuantity

public void setCurrencyQuantity(Integer currencyQuantity)

getMeta

public MetaInfo getMeta()

Description copied from interface: HasMeta

Create and last update info for the structure. This is optional and treated as read only since the data is set by the internals of the service during maintenance operations. Contains audit trail information about the creation and last update of this object Also contains the version ind used for optimistic locking. Attempts to set or update should result in a ReadOnlyException being thrown.

Specified by:

getMeta in interface HasMeta

setMeta

public void setMeta(MetaInfo metaInfo)