org.kuali.kfs.fp.businessobject
Class Deposit

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

All Implemented Interfaces:

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

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

This class represents a deposit used in the cash management document

See Also:

Serialized Form

Field Summary

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

extension, versionNumber

Constructor Summary

Deposit()
Default constructor.

Method Summary

boolean	containsCashReceipt(CashReceiptDocument crDoc) This method returns whether the given deposit contains the parameter cash receipt document
Bank	getBank() Gets the bank attribute.
CashManagementDocument	getCashManagementDocument()
org.kuali.rice.kns.util.KualiDecimal	getDepositAmount()
String	getDepositBankCode()
List	getDepositCashReceiptControl()
Date	getDepositDate()
CoinDetail	getDepositedCoin() Gets the depositedCoin attribute.
CurrencyDetail	getDepositedCurrency() Gets the depositedCurrency attribute.
String	getDepositTicketNumber()
String	getDepositTypeCode()
String	getDocumentNumber()
Integer	getFinancialDocumentDepositLineNumber()
String	getRawDepositTypeCode()
boolean	keysEqual(Deposit other) Returns true if this deposit has the same document deposit line number as the passed in Deposit
void	setBank(Bank bank) Sets the bank attribute value.
void	setCashManagementDocument(CashManagementDocument cashManagementDocument) Sets the cashManagementDocument attribute value.
void	setDepositAmount(org.kuali.rice.kns.util.KualiDecimal depositAmount) Sets the depositAmount attribute value.
void	setDepositBankCode(String depositBankCode) Sets the depositBankCode attribute value.
void	setDepositCashReceiptControl(List depositCashReceiptControl) Sets the depositCashReceiptControl attribute value.
void	setDepositDate(Date depositDate) Sets the depositDate attribute value.
void	setDepositedCoin(CoinDetail depositedCoin) Sets the depositedCoin attribute value.
void	setDepositedCurrency(CurrencyDetail depositedCurrency) Sets the depositedCurrency attribute value.
void	setDepositTicketNumber(String depositTicketNumber) Sets the depositTicketNumber attribute value.
void	setDepositTypeCode(String depositTypeCode) Sets the depositTypeCode attribute value.
void	setDocumentNumber(String documentNumber) Sets the documentNumber attribute value.
void	setFinancialDocumentDepositLineNumber(Integer financialDocumentDepositLineNumber) Sets the financialDocumentDepositLineNumber attribute value.
protected LinkedHashMap	toStringMapper()

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

Deposit

public Deposit()

Default constructor.

Method Detail

getBank

public Bank getBank()

Gets the bank attribute.

Returns:

Returns the bank.

setBank

public void setBank(Bank bank)

Sets the bank attribute value.

Parameters:

bank - The bank to set.

getCashManagementDocument

public CashManagementDocument getCashManagementDocument()

Returns:

current value of cashManagementDocument.

setCashManagementDocument

public void setCashManagementDocument(CashManagementDocument cashManagementDocument)

Sets the cashManagementDocument attribute value.

Parameters:

cashManagementDocument - The cashManagementDocument to set.

getDepositCashReceiptControl

public List getDepositCashReceiptControl()

Returns:

current value of depositCashReceiptControl.

setDepositCashReceiptControl

public void setDepositCashReceiptControl(List depositCashReceiptControl)

Sets the depositCashReceiptControl attribute value.

Parameters:

depositCashReceiptControl - The depositCashReceiptControl to set.

getDepositAmount

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

Returns:

current value of depositAmount.

setDepositAmount

public void setDepositAmount(org.kuali.rice.kns.util.KualiDecimal depositAmount)

Sets the depositAmount attribute value.

Parameters:

depositAmount - The depositAmount to set.

getDepositBankCode

public String getDepositBankCode()

Returns:

current value of depositBankCode.

setDepositBankCode

public void setDepositBankCode(String depositBankCode)

Sets the depositBankCode attribute value.

Parameters:

depositBankCode - The depositBankCode to set.

getDepositDate

public Date getDepositDate()

Returns:

current value of depositDate.

setDepositDate

public void setDepositDate(Date depositDate)

Sets the depositDate attribute value.

Parameters:

depositDate - The depositDate to set.

getDepositTicketNumber

public String getDepositTicketNumber()

Returns:

current value of depositTicketNumber.

setDepositTicketNumber

public void setDepositTicketNumber(String depositTicketNumber)

Sets the depositTicketNumber attribute value.

Parameters:

depositTicketNumber - The depositTicketNumber to set.

getRawDepositTypeCode

public String getRawDepositTypeCode()

Returns:

current value of depositTypeCode, under a different name, to prevent the POJO code from reformatting it

getDepositTypeCode

public String getDepositTypeCode()

Returns:

current value of depositTypeCode.

setDepositTypeCode

public void setDepositTypeCode(String depositTypeCode)

Sets the depositTypeCode attribute value.

Parameters:

depositTypeCode - The depositTypeCode to set.

getFinancialDocumentDepositLineNumber

public Integer getFinancialDocumentDepositLineNumber()

Returns:

current value of financialDocumentDepositLineNumber.

setFinancialDocumentDepositLineNumber

public void setFinancialDocumentDepositLineNumber(Integer financialDocumentDepositLineNumber)

Sets the financialDocumentDepositLineNumber attribute value.

Parameters:

financialDocumentDepositLineNumber - The financialDocumentDepositLineNumber to set.

getDocumentNumber

public String getDocumentNumber()

Returns:

current value of documentNumber.

setDocumentNumber

public void setDocumentNumber(String documentNumber)

Sets the documentNumber attribute value.

Parameters:

documentNumber - The documentNumber to set.

toStringMapper

protected LinkedHashMap toStringMapper()

Specified by:

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

See Also:

BusinessObjectBase.toStringMapper()

keysEqual

public boolean keysEqual(Deposit other)

Returns true if this deposit has the same document deposit line number as the passed in Deposit

Parameters:

other -

Returns:

true if the given Deposit has primary key values equal to this Deposit

containsCashReceipt

public boolean containsCashReceipt(CashReceiptDocument crDoc)

This method returns whether the given deposit contains the parameter cash receipt document

Parameters:

crDoc - the cash receipt document to look for

Returns:

true if the cash receipt document is part of the deposit, false if otherwise

getDepositedCoin

public CoinDetail getDepositedCoin()

Gets the depositedCoin attribute.

Returns:

Returns the depositedCoin.

setDepositedCoin

public void setDepositedCoin(CoinDetail depositedCoin)

Sets the depositedCoin attribute value.

Parameters:

depositedCoin - The depositedCoin to set.

getDepositedCurrency

public CurrencyDetail getDepositedCurrency()

Gets the depositedCurrency attribute.

Returns:

Returns the depositedCurrency.

setDepositedCurrency

public void setDepositedCurrency(CurrencyDetail depositedCurrency)

Sets the depositedCurrency attribute value.

Parameters:

depositedCurrency - The depositedCurrency to set.