org.kuali.kfs.fp.businessobject
Class CoinDetail

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

All Implemented Interfaces:

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

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

This class contains the coin breakdown for coin inserted into a cash drawer

See Also:

Serialized Form

Field Summary

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

extension, versionNumber

Constructor Summary

CoinDetail()
Default constructor.

Method Summary

void	add(CoinDetail detail)
String	getCashieringRecordSource() Gets the cashieringRecordSource attribute.
String	getDocumentNumber() Gets the documentNumber attribute.
Integer	getFiftyCentCount() Returns the number of half-cent coins in the drawer
org.kuali.rice.kns.util.KualiDecimal	getFinancialDocumentFiftyCentAmount() Gets the financialDocumentFiftyCentAmount attribute.
org.kuali.rice.kns.util.KualiDecimal	getFinancialDocumentFiveCentAmount() Gets the financialDocumentFiveCentAmount attribute.
org.kuali.rice.kns.util.KualiDecimal	getFinancialDocumentHundredCentAmount() Gets the financialDocumentHundredCentAmount attribute.
org.kuali.rice.kns.util.KualiDecimal	getFinancialDocumentOneCentAmount() Gets the financialDocumentOneCentAmount attribute.
org.kuali.rice.kns.util.KualiDecimal	getFinancialDocumentOtherCentAmount() Gets the financialDocumentOtherCentAmount attribute.
org.kuali.rice.kns.util.KualiDecimal	getFinancialDocumentTenCentAmount() Gets the financialDocumentTenCentAmount attribute.
org.kuali.rice.kns.util.KualiDecimal	getFinancialDocumentTwentyFiveCentAmount() Gets the financialDocumentTwentyFiveCentAmount attribute.
String	getFinancialDocumentTypeCode() Gets the financialDocumentTypeCode attribute.
Integer	getFiveCentCount() Returns the number of nickels in the drawer
Integer	getHundredCentCount() Returns the number of dollar coins--Sacajawea, Susan B.
Integer	getOneCentCount() Returns the number of pennies in the drawer
Integer	getTenCentCount() Returns the number of dimes in the drawer
org.kuali.rice.kns.util.KualiDecimal	getTotalAmount() Returns the total amount represented by this coin detail record.
Integer	getTwentyFiveCentCount() Returns the number of quarters in the drawer
boolean	isEmpty() Is this coin detail empty of any value?
void	setCashieringRecordSource(String financialDocumentColumnTypeCode) Sets the cashieringRecordSource attribute.
void	setDocumentNumber(String documentNumber) Sets the documentNumber attribute.
void	setFiftyCentCount(Integer count) Sets the number of fifty cent coins in the drawer.
void	setFinancialDocumentFiftyCentAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentFiftyCentAmount) Sets the financialDocumentFiftyCentAmount attribute.
void	setFinancialDocumentFiveCentAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentFiveCentAmount) Sets the financialDocumentFiveCentAmount attribute.
void	setFinancialDocumentHundredCentAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentHundredCentAmount) Sets the financialDocumentHundredCentAmount attribute.
void	setFinancialDocumentOneCentAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentOneCentAmount) Sets the financialDocumentOneCentAmount attribute.
void	setFinancialDocumentOtherCentAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentOtherCentAmount) Sets the financialDocumentOtherCentAmount attribute.
void	setFinancialDocumentTenCentAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentTenCentAmount) Sets the financialDocumentTenCentAmount attribute.
void	setFinancialDocumentTwentyFiveCentAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentTwentyFiveCentAmount) Sets the financialDocumentTwentyFiveCentAmount attribute.
void	setFinancialDocumentTypeCode(String financialDocumentTypeCode) Sets the financialDocumentTypeCode attribute.
void	setFiveCentCount(Integer count) Sets the number of nickels in the drawer
void	setHundredCentCount(Integer count) Sets the number of hundred cent coins in the drawer
void	setOneCentCount(Integer count) Sets the number of pennies in the drawer
void	setTenCentCount(Integer count) Sets the number of dimes in the drawer
void	setTwentyFiveCentCount(Integer count) Sets the number of quarters in the drawer
void	subtract(CoinDetail detail)
protected LinkedHashMap	toStringMapper()
void	zeroOutAmounts() This method sets all amounts in this record 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

CoinDetail

public CoinDetail()

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.

getFinancialDocumentFiftyCentAmount

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

Gets the financialDocumentFiftyCentAmount attribute.

Returns:

Returns the financialDocumentFiftyCentAmount

setFinancialDocumentFiftyCentAmount

public void setFinancialDocumentFiftyCentAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentFiftyCentAmount)

Sets the financialDocumentFiftyCentAmount attribute.

Parameters:

financialDocumentFiftyCentAmount - The financialDocumentFiftyCentAmount to set.

getFiftyCentCount

public Integer getFiftyCentCount()

Returns the number of half-cent coins in the drawer

Returns:

the count of half cent coins in the drawer

setFiftyCentCount

public void setFiftyCentCount(Integer count)

Sets the number of fifty cent coins in the drawer. This is useful if, you know, you're in da club, with, say a bottle full of "bub"

Parameters:

count - the number of fifty cent coins present in the drawer

getFinancialDocumentTwentyFiveCentAmount

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

Gets the financialDocumentTwentyFiveCentAmount attribute.

Returns:

Returns the financialDocumentTwentyFiveCentAmount

setFinancialDocumentTwentyFiveCentAmount

public void setFinancialDocumentTwentyFiveCentAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentTwentyFiveCentAmount)

Sets the financialDocumentTwentyFiveCentAmount attribute.

Parameters:

financialDocumentTwentyFiveCentAmount - The financialDocumentTwentyFiveCentAmount to set.

getTwentyFiveCentCount

public Integer getTwentyFiveCentCount()

Returns the number of quarters in the drawer

Returns:

the count of quarters in the drawer

setTwentyFiveCentCount

public void setTwentyFiveCentCount(Integer count)

Sets the number of quarters in the drawer

Parameters:

count - the number of quarters present in the drawer

getFinancialDocumentTenCentAmount

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

Gets the financialDocumentTenCentAmount attribute.

Returns:

Returns the financialDocumentTenCentAmount

setFinancialDocumentTenCentAmount

public void setFinancialDocumentTenCentAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentTenCentAmount)

Sets the financialDocumentTenCentAmount attribute.

Parameters:

financialDocumentTenCentAmount - The financialDocumentTenCentAmount to set.

getTenCentCount

public Integer getTenCentCount()

Returns the number of dimes in the drawer

Returns:

the count of dimes in the drawer

setTenCentCount

public void setTenCentCount(Integer count)

Sets the number of dimes in the drawer

Parameters:

count - the number of dimes present in the drawer

getFinancialDocumentFiveCentAmount

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

Gets the financialDocumentFiveCentAmount attribute.

Returns:

Returns the financialDocumentFiveCentAmount

setFinancialDocumentFiveCentAmount

public void setFinancialDocumentFiveCentAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentFiveCentAmount)

Sets the financialDocumentFiveCentAmount attribute.

Parameters:

financialDocumentFiveCentAmount - The financialDocumentFiveCentAmount to set.

getFiveCentCount

public Integer getFiveCentCount()

Returns the number of nickels in the drawer

Returns:

the count of nickels in the drawer

setFiveCentCount

public void setFiveCentCount(Integer count)

Sets the number of nickels in the drawer

Parameters:

count - the number of nickels present in the drawer

getFinancialDocumentOneCentAmount

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

Gets the financialDocumentOneCentAmount attribute.

Returns:

Returns the financialDocumentOneCentAmount

setFinancialDocumentOneCentAmount

public void setFinancialDocumentOneCentAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentOneCentAmount)

Sets the financialDocumentOneCentAmount attribute.

Parameters:

financialDocumentOneCentAmount - The financialDocumentOneCentAmount to set.

getOneCentCount

public Integer getOneCentCount()

Returns the number of pennies in the drawer

Returns:

the count of pennies in the drawer

setOneCentCount

public void setOneCentCount(Integer count)

Sets the number of pennies in the drawer

Parameters:

count - the number of pennies present in the drawer

getFinancialDocumentOtherCentAmount

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

Gets the financialDocumentOtherCentAmount attribute.

Returns:

Returns the financialDocumentOtherCentAmount

setFinancialDocumentOtherCentAmount

public void setFinancialDocumentOtherCentAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentOtherCentAmount)

Sets the financialDocumentOtherCentAmount attribute.

Parameters:

financialDocumentOtherCentAmount - The financialDocumentOtherCentAmount to set.

getFinancialDocumentHundredCentAmount

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

Gets the financialDocumentHundredCentAmount attribute.

Returns:

Returns the financialDocumentHundredCentAmount

setFinancialDocumentHundredCentAmount

public void setFinancialDocumentHundredCentAmount(org.kuali.rice.kns.util.KualiDecimal financialDocumentHundredCentAmount)

Sets the financialDocumentHundredCentAmount attribute.

Parameters:

financialDocumentHundredCentAmount - The financialDocumentHundredCentAmount to set.

getHundredCentCount

public Integer getHundredCentCount()

Returns the number of dollar coins--Sacajawea, Susan B. Anthony, or otherwise--in the drawer

Returns:

the count of dollar coins in the drawer

setHundredCentCount

public void setHundredCentCount(Integer count)

Sets the number of hundred cent coins in the drawer

Parameters:

count - the number of hundred cent coins present in the drawer

getTotalAmount

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

Returns the total amount represented by this coin detail record.

Returns:

total amount of this detail

zeroOutAmounts

public void zeroOutAmounts()

This method sets all amounts in this record to zero

zeroOutUnpopulatedAmounts

public void zeroOutUnpopulatedAmounts()

This method sets all amounts that are null to zero

add

public void add(CoinDetail detail)

subtract

public void subtract(CoinDetail detail)

isEmpty

public boolean isEmpty()

Is this coin detail empty of any value?

Returns:

true if any field at all is neither null nor the amount is zero

toStringMapper

protected LinkedHashMap toStringMapper()

Specified by:

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

See Also:

BusinessObjectBase.toStringMapper()