org.kuali.kfs.fp.businessobject
Class CurrencyDetail

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.kfs.fp.businessobject.CurrencyDetail

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.bo.PersistableBusinessObject

public class CurrencyDetail
extends org.kuali.rice.kns.bo.PersistableBusinessObjectBase

Represents a breakdown of currency amounts (i.e. $100, $50, $20, etc.)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

CurrencyDetail()
Default constructor.

Method Summary

void	add(CurrencyDetail detail) This method adds the amounts from the given currency detail record to this one
String	getCashieringRecordSource() Gets the cashieringRecordSource attribute.
String	getDocumentNumber() Gets the documentNumber attribute.
Integer	getFiftyDollarCount() Returns the actual count of fifty dollar bills
org.kuali.rice.kns.util.KualiDecimal	getFinancialDocumentFiftyDollarAmount() Gets the financialDocumentFiftyDollarAmount attribute.
org.kuali.rice.kns.util.KualiDecimal	getFinancialDocumentFiveDollarAmount() Gets the financialDocumentFiveDollarAmount attribute.
org.kuali.rice.kns.util.KualiDecimal	getFinancialDocumentHundredDollarAmount() Gets the financialDocumentHundredDollarAmount attribute.
org.kuali.rice.kns.util.KualiDecimal	getFinancialDocumentOneDollarAmount() Gets the financialDocumentOneDollarAmount attribute.
org.kuali.rice.kns.util.KualiDecimal	getFinancialDocumentOtherDollarAmount() Gets the financialDocumentOtherDollarAmount attribute.
org.kuali.rice.kns.util.KualiDecimal	getFinancialDocumentTenDollarAmount() Gets the financialDocumentTenDollarAmount attribute.
org.kuali.rice.kns.util.KualiDecimal	getFinancialDocumentTwentyDollarAmount() Gets the financialDocumentTwentyDollarAmount attribute.
org.kuali.rice.kns.util.KualiDecimal	getFinancialDocumentTwoDollarAmount() Gets the financialDocumentTwoDollarAmount attribute.
String	getFinancialDocumentTypeCode() Gets the financialDocumentTypeCode attribute.
Integer	getFiveDollarCount() Returns the actual count of five dollar bills
Integer	getHundredDollarCount() Returns the actual count of hundred dollar bills
Integer	getOneDollarCount() Returns the actual count of one dollar bills
Integer	getTenDollarCount() Returns the actual count of ten dollar bills
org.kuali.rice.kns.util.KualiDecimal	getTotalAmount() This method calculates the total amount represented by all the currency listed in this detail record
Integer	getTwentyDollarCount() Returns the actual count of twenty dollar bills
Integer	getTwoDollarCount() Returns the actual count of two dollar bills
boolean	isEmpty() Does this currency detail actually have any information in it?
void	setCashieringRecordSource(String financialDocumentColumnTypeCode) Sets the cashieringRecordSource attribute.
void	setDocumentNumber(String documentNumber) Sets the documentNumber attribute.
void	setFiftyDollarCount(Integer count) This sets the count of hundred dollar bills present in the drawer
void	setFinancialDocumentFiftyDollarAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentFiftyDollarAmount) Sets the financialDocumentFiftyDollarAmount attribute.
void	setFinancialDocumentFiveDollarAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentFiveDollarAmount) Sets the financialDocumentFiveDollarAmount attribute.
void	setFinancialDocumentHundredDollarAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentHundredDollarAmount) Sets the financialDocumentHundredDollarAmount attribute.
void	setFinancialDocumentOneDollarAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentOneDollarAmount) Sets the financialDocumentOneDollarAmount attribute.
void	setFinancialDocumentOtherDollarAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentOtherDollarAmount) Sets the financialDocumentOtherDollarAmount attribute.
void	setFinancialDocumentTenDollarAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentTenDollarAmount) Sets the financialDocumentTenDollarAmount attribute.
void	setFinancialDocumentTwentyDollarAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentTwentyDollarAmount) Sets the financialDocumentTwentyDollarAmount attribute.
void	setFinancialDocumentTwoDollarAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentTwoDollarAmount) Sets the financialDocumentTwoDollarAmount attribute.
void	setFinancialDocumentTypeCode(String financialDocumentTypeCode) Sets the financialDocumentTypeCode attribute.
void	setFiveDollarCount(Integer count) This sets the count of five dollar bills present in the drawer
void	setHundredDollarCount(Integer count) This sets the count of hundred dollar bills present in the drawer
void	setOneDollarCount(Integer count) This sets the count of one dollar bills present in the drawer
void	setTenDollarCount(Integer count) This sets the count of ten dollar bills present in the drawer
void	setTwentyDollarCount(Integer count) This sets the count of twenty dollar bills present in the drawer
void	setTwoDollarCount(Integer count) This sets the count of two dollar bills present in the drawer
void	subtract(CurrencyDetail detail) This method subtracts the given currency detail from this one
protected LinkedHashMap	toStringMapper()
void	zeroOutAmounts() This method sets all the amounts to zero
void	zeroOutUnpopulatedAmounts() This method sets all amounts that are null to zero

Methods inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

addNote, afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeInsert, beforeUpdate, beforeUpdate, buildListOfDeletionAwareLists, deleteNote, getAttachmentService, getBoNote, getBoNotes, getExtension, getNoteService, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isAutoIncrementSet, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setAutoIncrementSet, setBoNotes, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber, supportsBoNotes

Methods inherited from class org.kuali.rice.kns.bo.BusinessObjectBase

prepareForWorkflow, toString, toStringBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.kns.bo.BusinessObject

prepareForWorkflow

Constructor Detail

CurrencyDetail

public CurrencyDetail()

Default constructor.

Method Detail

getDocumentNumber

public String getDocumentNumber()

Gets the documentNumber attribute.

Returns:

Returns the documentNumber

setDocumentNumber

public void setDocumentNumber(String documentNumber)

Sets the documentNumber attribute.

Parameters:

documentNumber - The documentNumber to set.

getFinancialDocumentTypeCode

public String getFinancialDocumentTypeCode()

Gets the financialDocumentTypeCode attribute.

Returns:

Returns the financialDocumentTypeCode

setFinancialDocumentTypeCode

public void setFinancialDocumentTypeCode(String financialDocumentTypeCode)

Sets the financialDocumentTypeCode attribute.

Parameters:

financialDocumentTypeCode - The financialDocumentTypeCode to set.

getCashieringRecordSource

public String getCashieringRecordSource()

Gets the cashieringRecordSource attribute.

Returns:

Returns the cashieringRecordSource

setCashieringRecordSource

public void setCashieringRecordSource(String financialDocumentColumnTypeCode)

Sets the cashieringRecordSource attribute.

Parameters:

cashieringRecordSource - The cashieringRecordSource to set.

getFinancialDocumentHundredDollarAmount

public org.kuali.rice.kns.util.KualiDecimal getFinancialDocumentHundredDollarAmount()

Gets the financialDocumentHundredDollarAmount attribute.

Returns:

Returns the financialDocumentHundredDollarAmount

setFinancialDocumentHundredDollarAmount

public void setFinancialDocumentHundredDollarAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentHundredDollarAmount)

Sets the financialDocumentHundredDollarAmount attribute.

Parameters:

financialDocumentHundredDollarAmount - The financialDocumentHundredDollarAmount to set.

getHundredDollarCount

public Integer getHundredDollarCount()

Returns the actual count of hundred dollar bills

Returns:

the number of hundred dollar bills present in the drawer

setHundredDollarCount

public void setHundredDollarCount(Integer count)

This sets the count of hundred dollar bills present in the drawer

Parameters:

count - the number of hundred dollar bills present in the drawer

getFinancialDocumentFiftyDollarAmount

public org.kuali.rice.kns.util.KualiDecimal getFinancialDocumentFiftyDollarAmount()

Gets the financialDocumentFiftyDollarAmount attribute.

Returns:

Returns the financialDocumentFiftyDollarAmount

setFinancialDocumentFiftyDollarAmount

public void setFinancialDocumentFiftyDollarAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentFiftyDollarAmount)

Sets the financialDocumentFiftyDollarAmount attribute.

Parameters:

financialDocumentFiftyDollarAmount - The financialDocumentFiftyDollarAmount to set.

getFiftyDollarCount

public Integer getFiftyDollarCount()

Returns the actual count of fifty dollar bills

Returns:

the number of fifty dollar bills present in the drawer

setFiftyDollarCount

public void setFiftyDollarCount(Integer count)

This sets the count of hundred dollar bills present in the drawer

Parameters:

count - the number of hundred dollar bills present in the drawer

getFinancialDocumentTwentyDollarAmount

public org.kuali.rice.kns.util.KualiDecimal getFinancialDocumentTwentyDollarAmount()

Gets the financialDocumentTwentyDollarAmount attribute.

Returns:

Returns the financialDocumentTwentyDollarAmount

setFinancialDocumentTwentyDollarAmount

public void setFinancialDocumentTwentyDollarAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentTwentyDollarAmount)

Sets the financialDocumentTwentyDollarAmount attribute.

Parameters:

financialDocumentTwentyDollarAmount - The financialDocumentTwentyDollarAmount to set.

getTwentyDollarCount

public Integer getTwentyDollarCount()

Returns the actual count of twenty dollar bills

Returns:

the number of twenty dollar bills present in the drawer

setTwentyDollarCount

public void setTwentyDollarCount(Integer count)

This sets the count of twenty dollar bills present in the drawer

Parameters:

count - the number of twenty dollar bills present in the drawer

getFinancialDocumentTenDollarAmount

public org.kuali.rice.kns.util.KualiDecimal getFinancialDocumentTenDollarAmount()

Gets the financialDocumentTenDollarAmount attribute.

Returns:

Returns the financialDocumentTenDollarAmount

setFinancialDocumentTenDollarAmount

public void setFinancialDocumentTenDollarAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentTenDollarAmount)

Sets the financialDocumentTenDollarAmount attribute.

Parameters:

financialDocumentTenDollarAmount - The financialDocumentTenDollarAmount to set.

getTenDollarCount

public Integer getTenDollarCount()

Returns the actual count of ten dollar bills

Returns:

the number of ten dollar bills present in the drawer

setTenDollarCount

public void setTenDollarCount(Integer count)

This sets the count of ten dollar bills present in the drawer

Parameters:

count - the number of ten dollar bills present in the drawer

getFinancialDocumentFiveDollarAmount

public org.kuali.rice.kns.util.KualiDecimal getFinancialDocumentFiveDollarAmount()

Gets the financialDocumentFiveDollarAmount attribute.

Returns:

Returns the financialDocumentFiveDollarAmount

setFinancialDocumentFiveDollarAmount

public void setFinancialDocumentFiveDollarAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentFiveDollarAmount)

Sets the financialDocumentFiveDollarAmount attribute.

Parameters:

financialDocumentFiveDollarAmount - The financialDocumentFiveDollarAmount to set.

getFiveDollarCount

public Integer getFiveDollarCount()

Returns the actual count of five dollar bills

Returns:

the number of five dollar bills present in the drawer

setFiveDollarCount

public void setFiveDollarCount(Integer count)

This sets the count of five dollar bills present in the drawer

Parameters:

count - the number of five dollar bills present in the drawer

getFinancialDocumentTwoDollarAmount

public org.kuali.rice.kns.util.KualiDecimal getFinancialDocumentTwoDollarAmount()

Gets the financialDocumentTwoDollarAmount attribute.

Returns:

Returns the financialDocumentTwoDollarAmount

setFinancialDocumentTwoDollarAmount

public void setFinancialDocumentTwoDollarAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentTwoDollarAmount)

Sets the financialDocumentTwoDollarAmount attribute.

Parameters:

financialDocumentTwoDollarAmount - The financialDocumentTwoDollarAmount to set.

getTwoDollarCount

public Integer getTwoDollarCount()

Returns the actual count of two dollar bills

Returns:

the number of two dollar bills present in the drawer

setTwoDollarCount

public void setTwoDollarCount(Integer count)

This sets the count of two dollar bills present in the drawer

Parameters:

count - the number of two dollar bills present in the drawer

getFinancialDocumentOneDollarAmount

public org.kuali.rice.kns.util.KualiDecimal getFinancialDocumentOneDollarAmount()

Gets the financialDocumentOneDollarAmount attribute.

Returns:

Returns the financialDocumentOneDollarAmount

setFinancialDocumentOneDollarAmount

public void setFinancialDocumentOneDollarAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentOneDollarAmount)

Sets the financialDocumentOneDollarAmount attribute.

Parameters:

financialDocumentOneDollarAmount - The financialDocumentOneDollarAmount to set.

getOneDollarCount

public Integer getOneDollarCount()

Returns the actual count of one dollar bills

Returns:

the number of one dollar bills present in the drawer

setOneDollarCount

public void setOneDollarCount(Integer count)

This sets the count of one dollar bills present in the drawer

Parameters:

count - the number of one dollar bills present in the drawer

getFinancialDocumentOtherDollarAmount

public org.kuali.rice.kns.util.KualiDecimal getFinancialDocumentOtherDollarAmount()

Gets the financialDocumentOtherDollarAmount attribute.

Returns:

Returns the financialDocumentOtherDollarAmount

setFinancialDocumentOtherDollarAmount

public void setFinancialDocumentOtherDollarAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentOtherDollarAmount)

Sets the financialDocumentOtherDollarAmount attribute.

Parameters:

financialDocumentOtherDollarAmount - The financialDocumentOtherDollarAmount to set.

getTotalAmount

public org.kuali.rice.kns.util.KualiDecimal getTotalAmount()

This method calculates the total amount represented by all the currency listed in this detail record

Returns:

total amount of this detail

zeroOutAmounts

public void zeroOutAmounts()

This method sets all the amounts to zero

zeroOutUnpopulatedAmounts

public void zeroOutUnpopulatedAmounts()

This method sets all amounts that are null to zero

add

public void add(CurrencyDetail detail)

This method adds the amounts from the given currency detail record to this one

Parameters:

detail - the currency detail to add onto this

subtract

public void subtract(CurrencyDetail detail)

This method subtracts the given currency detail from this one

Parameters:

detail - the detail to subtract

isEmpty

public boolean isEmpty()

Does this currency detail actually have any information in it?

Returns:

true if any field at all is not null and not zero, false if otherwise

toStringMapper

protected LinkedHashMap toStringMapper()

Specified by:

toStringMapper in class org.kuali.rice.kns.bo.BusinessObjectBase

See Also:

BusinessObjectBase.toStringMapper()