org.kuali.ole.fp.document

Class CashReceiptDocument

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.rice.krad.document.DocumentBase

org.kuali.rice.krad.document.TransactionalDocumentBase

org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase

org.kuali.ole.sys.document.LedgerPostingDocumentBase

org.kuali.ole.sys.document.GeneralLedgerPostingDocumentBase

org.kuali.ole.sys.document.AccountingDocumentBase

org.kuali.ole.fp.document.CapitalAssetInformationDocumentBase

org.kuali.ole.fp.document.CapitalAccountingLinesDocumentBase

org.kuali.ole.fp.document.CashReceiptFamilyBase

org.kuali.ole.fp.document.CashReceiptDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, CapitalAssetEditable, AccountingDocument, AmountTotaling, FinancialSystemDocument, FinancialSystemTransactionalDocument, GeneralLedgerPendingEntrySource, GeneralLedgerPostingDocument, LedgerPostingDocument, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject, org.kuali.rice.krad.document.Copyable, org.kuali.rice.krad.document.Document, org.kuali.rice.krad.document.SessionDocument, org.kuali.rice.krad.document.TransactionalDocument

public class CashReceiptDocument
extends CashReceiptFamilyBase
implements org.kuali.rice.krad.document.Copyable, AmountTotaling, CapitalAssetEditable

This is the business object that represents the CashReceiptDocument in Kuali. This is a transactional document that will eventually post transactions to the G/L. It integrates with workflow. Since a Cash Receipt is a one sided transactional document, only accepting funds into the university, the accounting line data will be held in the source accounting line data structure only.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected CoinDetail	changeCoinDetail
protected CurrencyDetail	changeCurrencyDetail
static String	CHECK_ENTRY_DETAIL
static String	CHECK_ENTRY_TOTAL
protected String	checkEntryMode
protected List<Check>	checks
protected CoinDetail	coinDetail
protected List<Check>	confirmedChecks
protected CoinDetail	confirmedCoinDetail
protected CurrencyDetail	confirmedCurrencyDetail
protected String	createDate
protected CurrencyDetail	currencyDetail
protected List<DepositCashReceiptControl>	depositCashReceiptControl
static String	DOCUMENT_TYPE
protected Integer	nextCheckSequenceId
protected Integer	nextConfirmedCheckSequenceId
protected boolean	recategorized
protected org.kuali.rice.core.api.util.type.KualiDecimal	sumTotalAmount
protected org.kuali.rice.core.api.util.type.KualiDecimal	totalCashAmount
protected org.kuali.rice.core.api.util.type.KualiDecimal	totalChangeAmount
protected org.kuali.rice.core.api.util.type.KualiDecimal	totalCheckAmount
protected org.kuali.rice.core.api.util.type.KualiDecimal	totalCoinAmount
protected org.kuali.rice.core.api.util.type.KualiDecimal	totalConfirmedCashAmount
protected org.kuali.rice.core.api.util.type.KualiDecimal	totalConfirmedCheckAmount
protected org.kuali.rice.core.api.util.type.KualiDecimal	totalConfirmedCoinAmount

Fields inherited from class org.kuali.ole.fp.document.CashReceiptFamilyBase

campusLocationCode, depositDate

Fields inherited from class org.kuali.ole.fp.document.CapitalAccountingLinesDocumentBase

capitalAccountingLines

Fields inherited from class org.kuali.ole.fp.document.CapitalAssetInformationDocumentBase

capitalAssetInformation, nextCapitalAssetLineNumber

Fields inherited from class org.kuali.ole.sys.document.AccountingDocumentBase

dataDictionaryEntry, nextSourceLineNumber, nextTargetLineNumber, sourceAccountingLineClass, sourceAccountingLines, targetAccountingLineClass, targetAccountingLines

Fields inherited from class org.kuali.ole.sys.document.GeneralLedgerPostingDocumentBase

generalLedgerPendingEntries

Fields inherited from class org.kuali.ole.sys.document.LedgerPostingDocumentBase

accountingPeriod, accountingPeriodService, checkPostingYearForCopy, dataDictionaryService, dateTimeService, postingPeriodCode, postingYear

Fields inherited from class org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase

UPDATE_TOTAL_AMOUNT_IN_POST_PROCESSING_PARAMETER_NAME

Fields inherited from class org.kuali.rice.krad.document.DocumentBase

documentHeader, documentNumber

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

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
CashReceiptDocument() Initializes the array lists and line incrementers.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCheck(Check check) Adds a new check to the list.
void	addConfirmedCheck(Check check) Adds a new confirmed check to the list.
protected Map	buildCheckMap(Collection checks)
List	buildListOfDeletionAwareLists()
org.kuali.rice.core.api.util.type.KualiDecimal	calculateCheckTotal()
org.kuali.rice.core.api.util.type.KualiDecimal	calculateConfirmedCheckTotal()
List<SufficientFundsItem>	checkSufficientFunds() This method will check sufficient funds for the document
Check	createNewCheck()
Check	createNewConfirmedCheck()
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent) Override to set the document status to VERIFIED ("V") when the document is FINAL.
boolean	existDepositableChecks() Checks if there are checks to be deposited
protected List	generateEvents(Collection persistedChecks, List currentChecks, String errorPathPrefix, CashReceiptFamilyBase crdoc) Generates a List of instances of CheckEvent subclasses, one for each changed check in the union of the persistedLines and currentLines lists.
List	generateSaveEvents()
protected Map	getCashDetailPrimaryKey() Generate the primary key for a currency or coin detail related to this document
protected Map	getChangeCashDetailPrimaryKey()
CoinDetail	getChangeCoinDetail() Gets the changeCoinDetail attribute.
CurrencyDetail	getChangeCurrencyDetail() Gets the changeCurrencyDetail attribute.
Check	getCheck(int index) Retrieve a particular check at a given index in the list of checks.
int	getCheckCount() Gets the number of checks, since Sun doesn't have a direct getter for collection size
String	getCheckEntryMode()
List<Check>	getChecks() Gets the checks attribute.
CoinDetail	getCoinDetail() Gets the coinDetail attribute.
protected Map	getConfirmedCashDetailPrimaryKey()
Check	getConfirmedCheck(int index) Retrieve a particular check at a given index in the list of confirmed checks.
int	getConfirmedCheckCount() Gets the number of confirmed checks
List<Check>	getConfirmedChecks() Gets the confirmed checks attribute.
CoinDetail	getConfirmedCoinDetail() Gets the confirmedCoinDetail attribute.
CurrencyDetail	getConfirmedCurrencyDetail() Gets the confirmedCurrencyDetail attribute.
String	getCreateDate() This method...
CurrencyDetail	getCurrencyDetail() Gets the currencyDetail attribute.
String	getCurrencyFormattedChangeTotalAmount() Retrieves the change total amount in a currency format with commas.
String	getCurrencyFormattedConfirmedSumTotalAmount() Retrieves the confirmed summed total amount in a currency format with commas.
String	getCurrencyFormattedFinalSumTotalAmount() Retrieves the final summed total amount (after subtracting change amount)in currency format with commas.
String	getCurrencyFormattedGrandTotalConfirmedCashAmount() returns (confirmed currency + confirmed coin - change amount) as a currency formatted string
String	getCurrencyFormattedSumTotalAmount() Retrieves the summed total amount in a currency format with commas.
String	getCurrencyFormattedTotalCashAmount() This method returns the cash total amount as a currency formatted string.
String	getCurrencyFormattedTotalCheckAmount() This method returns the check total amount as a currency formatted string.
String	getCurrencyFormattedTotalCoinAmount() This method returns the coin total amount as a currency formatted string.
String	getCurrencyFormattedTotalConfirmedCashAmount()
String	getCurrencyFormattedTotalConfirmedCheckAmount() This method returns the confirmed check total amount as a currency formatted string.
String	getCurrencyFormattedTotalConfirmedCoinAmount() This method returns the confirmed coin total amount as a currency formatted string.
String	getCurrencyFormattedTotalDepositableCheckAmount() This method returns the total depositable check amount as a currency formatted string.
List	getDepositCashReceiptControl() Gets the depositCashReceiptControl attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getGrandTotalConfirmedCashAmount() returns (confirmed currency + confirmed coin - change amount)
Integer	getNextCheckSequenceId() Gets the nextCheckSequenceId attribute.
Integer	getNextConfirmedCheckSequenceId() Gets the nextConfirmedCheckSequenceId attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getSumTotalAmount() Gets the sumTotalAmount attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalCashAmount() Gets the totalCashAmount attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalChangeAmount()
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalChangeCashAmount() Gets the totalChangeCashAmount attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalChangeCoinAmount() Gets the totalChangeCoinAmount attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalCheckAmount() Gets the totalCheckAmount attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalCoinAmount() Gets the totalCoinAmount attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalConfirmedCashAmount() Gets the totalConfirmedCashAmount attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalConfirmedCheckAmount() Gets the totalConfirmedCheckAmount attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalConfirmedCheckAmountForInterim() Gets the totalConfirmedCheckAmount attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalConfirmedCoinAmount() Gets the totalConfirmedCoinAmount attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalConfirmedDollarAmount() This method returns the overall confirmed total of the document - coin plus check plus cash.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalDepositableCheckAmount() Gets the total amount of depositable checks
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalDollarAmount() This method returns the overall total of the document - coin plus check plus cash.
void	initializeCampusLocationCode() Initializes the campus location code based on ole user role chart org
boolean	isRecategorized() Gets the recategorized attribute.
void	postProcessSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)
void	prepareForSave() If the document has a total amount, call method on document to get the total and set in doc header.
void	processAfterRetrieve() This is the default implementation which ensures that document note attachment references are loaded.
void	refreshCashDetails() This method refreshes the currency/coin details for this cash receipt document
void	removeCheck(int index) This method removes a check from the list and updates the total appropriately.
void	removeConfirmedCheck(int index) This method removes a confirmed check from the list and updates the total appropriately.
protected CoinDetail	retrieveChangeCoinDetail() Get this document's change coin detail from the database
protected CurrencyDetail	retrieveChangeCurrencyDetail() Get this document's change currency detail from the database
protected CoinDetail	retrieveCoinDetail() Grab this document's coin detail from the database
protected CoinDetail	retrieveConfirmedCoinDetail() Get this document's confirmed coin detail from the database
protected CurrencyDetail	retrieveConfirmedCurrencyDetail() Get this document's confirmed currency detail from the database
protected CurrencyDetail	retrieveCurrencyDetail() Get this document's currency detail from the database
void	setChangeCoinDetail(CoinDetail changeCoinDetail) Sets the changeCoinDetail attribute value.
void	setChangeCurrencyDetail(CurrencyDetail changeCurrencyDetail) Sets the changeCurrencyDetail attribute value.
void	setCheckEntryMode(String checkEntryMode)
void	setChecks(List<Check> checks) Sets the checks attribute value.
void	setCoinDetail(CoinDetail coinDetail) Sets the coinDetail attribute value.
void	setConfirmedChecks(List<Check> confirmedChecks) Sets the confirmed checks attribute value.
void	setConfirmedCoinDetail(CoinDetail coinDetail) Sets the confirmedCoinDetail attribute value.
void	setConfirmedCurrencyDetail(CurrencyDetail confirmedCurrencyDetail) Sets the confirmedCurrencyDetail attribute value.
void	setCurrencyDetail(CurrencyDetail currencyDetail) Sets the currencyDetail attribute value.
void	setDepositCashReceiptControl(List depositCashReceiptControl) Sets the depositCashReceiptControl attribute value.
void	setNextCheckSequenceId(Integer nextCheckSequenceId) Sets the nextCheckSequenceId attribute value.
void	setNextConfirmedCheckSequenceId(Integer nextConfirmedCheckSequenceId) Sets the nextCheckSequenceId attribute value.
void	setRecategorized(boolean recategorized) Sets the recategorized attribute value.
void	setSumTotalAmount(org.kuali.rice.core.api.util.type.KualiDecimal sumTotalAmount) Sets the sumTotalAmount attribute.
void	setTotalCashAmount(org.kuali.rice.core.api.util.type.KualiDecimal cashAmount) Sets the totalCashAmount attribute value.
void	setTotalCheckAmount(org.kuali.rice.core.api.util.type.KualiDecimal totalCheckAmount) Sets the totalCheckAmount attribute value.
void	setTotalCoinAmount(org.kuali.rice.core.api.util.type.KualiDecimal totalCoinAmount) Sets the totalCoinAmount attribute value.
void	setTotalConfirmedCashAmount(org.kuali.rice.core.api.util.type.KualiDecimal confirmedCashAmount) Sets the totalConfirmedCashAmount attribute value.
void	setTotalConfirmedCheckAmount(org.kuali.rice.core.api.util.type.KualiDecimal totalConfirmedCheckAmount) Sets the totalCheckAmount attribute value.
void	setTotalConfirmedCoinAmount(org.kuali.rice.core.api.util.type.KualiDecimal totalConfirmedCoinAmount) Sets the totalConfirmedCoinAmount attribute value.
void	toCopy() Override the campus code on the copied document to whatever the campus of the copying user is

Methods inherited from class org.kuali.ole.fp.document.CashReceiptFamilyBase

customizeExplicitGeneralLedgerPendingEntry, documentPerformsSufficientFundsCheck, getCampusLocationCode, getCapitalAssetInformation, getCapitalAssetManagementModuleService, getDepositDate, getSourceAccountingLinesSectionTitle, getSourceTotal, getTargetAccountingLinesSectionTitle, getTargetTotal, isDebit, setCampusLocationCode, setCapitalAssetInformation, setDepositDate

Methods inherited from class org.kuali.ole.fp.document.CapitalAccountingLinesDocumentBase

getCapitalAccountingLines, setCapitalAccountingLines

Methods inherited from class org.kuali.ole.fp.document.CapitalAssetInformationDocumentBase

getNextCapitalAssetLineNumber, setNextCapitalAssetLineNumber

Methods inherited from class org.kuali.ole.sys.document.AccountingDocumentBase

addSourceAccountingLine, addTargetAccountingLine, buildAccountingLineMap, copyAccountingLines, customizeOffsetGeneralLedgerPendingEntry, generateDocumentGeneralLedgerPendingEntries, generateEvents, generateGeneralLedgerPendingEntries, getAccountingLineParser, getDataDictionaryEntry, getDocumentClassForAccountingLineValueAllowedValidation, getEntryValue, getGeneralLedgerPendingEntryAmountForDetail, getGeneralLedgerPendingEntrySourceDetails, getNextSourceLineNumber, getNextTargetLineNumber, getPersistedSourceAccountingLinesForComparison, getPersistedTargetAccountingLinesForComparison, getSourceAccountingLine, getSourceAccountingLineClass, getSourceAccountingLineEntryName, getSourceAccountingLines, getSourceAccountingLinesForComparison, getTargetAccountingLine, getTargetAccountingLineClass, getTargetAccountingLineEntryName, getTargetAccountingLines, getTargetAccountingLinesForComparison, isDocumentFinalOrProcessed, prepareForSave, processExplicitGeneralLedgerPendingEntry, processOffsetGeneralLedgerPendingEntry, setNextSourceLineNumber, setNextTargetLineNumber, setSourceAccountingLines, setTargetAccountingLines, toErrorCorrection, updatePostingYearForAccountingLines

Methods inherited from class org.kuali.ole.sys.document.GeneralLedgerPostingDocumentBase

addPendingEntry, changeGeneralLedgerPendingEntriesApprovedStatusCode, clearAnyGeneralLedgerPendingEntries, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, removeGeneralLedgerPendingEntries, setGeneralLedgerPendingEntries

Methods inherited from class org.kuali.ole.sys.document.LedgerPostingDocumentBase

createInitialAccountingPeriod, getAccountingPeriod, getAccountingPeriodCompositeString, getAccountingPeriodService, getDataDictionaryService, getDateTimeService, getFinancialDocumentTypeCode, getPostingPeriodCode, getPostingYear, retrieveCurrentAccountingPeriod, setAccountingPeriod, setAccountingPeriodCompositeString, setPostingPeriodCode, setPostingYear

Methods inherited from class org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase

answerSplitNodeQuestion, doRouteLevelChange, getApplicationDocumentStatus, getBusinessObjectService, getFinancialSystemDocumentHeader, getFinancialSystemDocumentService, getParameterService, setApplicationDocumentStatus, setDocumentHeader, updateAndSaveAppDocStatus

Methods inherited from class org.kuali.rice.krad.document.TransactionalDocumentBase

getAllowsCopy, isSessionDocument

Methods inherited from class org.kuali.rice.krad.document.DocumentBase

addCopyErrorDocumentNote, addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postLoad, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentNumber, setNewDocumentHeader, setNotes, setPessimisticLocks, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refreshNonUpdateableReferences, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

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

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.ole.fp.document.CapitalAssetEditable

getCapitalAssetInformation, setCapitalAssetInformation

Methods inherited from interface org.kuali.ole.sys.document.GeneralLedgerPostingDocument

getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, setGeneralLedgerPendingEntries

Methods inherited from interface org.kuali.ole.sys.document.LedgerPostingDocument

getAccountingPeriod, getPostingPeriodCode, getPostingYear, setAccountingPeriod, setPostingPeriodCode, setPostingYear

Methods inherited from interface org.kuali.ole.sys.document.FinancialSystemDocument

answerSplitNodeQuestion, getFinancialSystemDocumentHeader

Methods inherited from interface org.kuali.rice.krad.document.Document

addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNotes, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from interface org.kuali.rice.krad.bo.PersistableBusinessObject

getExtension, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

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

refresh

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Methods inherited from interface org.kuali.ole.sys.document.GeneralLedgerPendingEntrySource

addPendingEntry, clearAnyGeneralLedgerPendingEntries, getDocumentHeader, getFinancialDocumentTypeCode, getFinancialSystemDocumentHeader, getPostingYear

Field Detail

CHECK_ENTRY_DETAIL

public static final String CHECK_ENTRY_DETAIL

See Also:

Constant Field Values

CHECK_ENTRY_TOTAL

public static final String CHECK_ENTRY_TOTAL

See Also:

Constant Field Values

DOCUMENT_TYPE

public static final String DOCUMENT_TYPE

See Also:

Constant Field Values

checkEntryMode

protected String checkEntryMode

checks

protected List<Check> checks

confirmedChecks

protected List<Check> confirmedChecks

depositCashReceiptControl

protected List<DepositCashReceiptControl> depositCashReceiptControl

nextCheckSequenceId

protected Integer nextCheckSequenceId

nextConfirmedCheckSequenceId

protected Integer nextConfirmedCheckSequenceId

totalCashAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal totalCashAmount

totalCheckAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal totalCheckAmount

totalCoinAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal totalCoinAmount

sumTotalAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal sumTotalAmount

totalConfirmedCashAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal totalConfirmedCashAmount

totalConfirmedCheckAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal totalConfirmedCheckAmount

totalConfirmedCoinAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal totalConfirmedCoinAmount

totalChangeAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal totalChangeAmount

currencyDetail

protected CurrencyDetail currencyDetail

coinDetail

protected CoinDetail coinDetail

confirmedCurrencyDetail

protected CurrencyDetail confirmedCurrencyDetail

confirmedCoinDetail

protected CoinDetail confirmedCoinDetail

changeCurrencyDetail

protected CurrencyDetail changeCurrencyDetail

changeCoinDetail

protected CoinDetail changeCoinDetail

recategorized

protected boolean recategorized

createDate

protected String createDate

Constructor Detail

CashReceiptDocument

public CashReceiptDocument()

Initializes the array lists and line incrementers.

Method Detail

getTotalCashAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalCashAmount()

Gets the totalCashAmount attribute.

Returns:

Returns the totalCashAmount.

getTotalConfirmedCashAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalConfirmedCashAmount()

Gets the totalConfirmedCashAmount attribute.

Returns:

Returns the totalConfirmedCashAmount.

getTotalChangeCashAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalChangeCashAmount()

Gets the totalChangeCashAmount attribute.

Returns:

Returns the totalChangeCashAmount.

getTotalDepositableCheckAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalDepositableCheckAmount()

Gets the total amount of depositable checks

Returns:

existDepositableChecks

public boolean existDepositableChecks()

Checks if there are checks to be deposited

Returns:

getCurrencyFormattedTotalDepositableCheckAmount

public String getCurrencyFormattedTotalDepositableCheckAmount()

This method returns the total depositable check amount as a currency formatted string.

Returns:

getCurrencyFormattedTotalCashAmount

public String getCurrencyFormattedTotalCashAmount()

This method returns the cash total amount as a currency formatted string.

Returns:

String

getCurrencyFormattedTotalConfirmedCashAmount

public String getCurrencyFormattedTotalConfirmedCashAmount()

setTotalCashAmount

public void setTotalCashAmount(org.kuali.rice.core.api.util.type.KualiDecimal cashAmount)

Sets the totalCashAmount attribute value.

Parameters:

cashAmount - The totalCashAmount to set.

setTotalConfirmedCashAmount

public void setTotalConfirmedCashAmount(org.kuali.rice.core.api.util.type.KualiDecimal confirmedCashAmount)

Sets the totalConfirmedCashAmount attribute value.

Parameters:

cashAmount - The totalConfirmedCashAmount to set.

setCheckEntryMode

public void setCheckEntryMode(String checkEntryMode)

Parameters:

checkEntryMode -

getCheckEntryMode

public String getCheckEntryMode()

Returns:

checkEntryMode

getChecks

public List<Check> getChecks()

Gets the checks attribute.

Returns:

Returns the checks.

setChecks

public void setChecks(List<Check> checks)

Sets the checks attribute value.

Parameters:

checks - The checks to set.

getConfirmedChecks

public List<Check> getConfirmedChecks()

Gets the confirmed checks attribute.

Returns:

Returns the confirmed checks.

setConfirmedChecks

public void setConfirmedChecks(List<Check> confirmedChecks)

Sets the confirmed checks attribute value.

Parameters:

confirmedChecks - The checks to set.

getCheckCount

public int getCheckCount()

Gets the number of checks, since Sun doesn't have a direct getter for collection size

Returns:

the number of checks

getConfirmedCheckCount

public int getConfirmedCheckCount()

Gets the number of confirmed checks

Returns:

the number of checks

addCheck

public void addCheck(Check check)

Adds a new check to the list.

Parameters:

check -

addConfirmedCheck

public void addConfirmedCheck(Check check)

Adds a new confirmed check to the list.

Parameters:

check -

getCheck

public Check getCheck(int index)

Retrieve a particular check at a given index in the list of checks.

Parameters:

index -

Returns:

Check

getConfirmedCheck

public Check getConfirmedCheck(int index)

Retrieve a particular check at a given index in the list of confirmed checks.

Parameters:

index -

Returns:

Check

checkSufficientFunds

public List<SufficientFundsItem> checkSufficientFunds()

Description copied from interface: GeneralLedgerPostingDocument

This method will check sufficient funds for the document

Specified by:

checkSufficientFunds in interface GeneralLedgerPostingDocument

Overrides:

checkSufficientFunds in class GeneralLedgerPostingDocumentBase

Returns:

a list of sufficientfundsitems that do not have sufficient funds. It returns an empty list if there is sufficient funds for the entire document

See Also:

GeneralLedgerPostingDocumentBase.checkSufficientFunds()

removeCheck

public void removeCheck(int index)

This method removes a check from the list and updates the total appropriately.

Parameters:

index -

removeConfirmedCheck

public void removeConfirmedCheck(int index)

This method removes a confirmed check from the list and updates the total appropriately.

Parameters:

index -

getNextCheckSequenceId

public Integer getNextCheckSequenceId()

Gets the nextCheckSequenceId attribute.

Returns:

Returns the nextCheckSequenceId.

setNextCheckSequenceId

public void setNextCheckSequenceId(Integer nextCheckSequenceId)

Sets the nextCheckSequenceId attribute value.

Parameters:

nextCheckSequenceId - The nextCheckSequenceId to set.

getNextConfirmedCheckSequenceId

public Integer getNextConfirmedCheckSequenceId()

Gets the nextConfirmedCheckSequenceId attribute.

Returns:

Returns the nextConfirmedCheckSequenceId.

setNextConfirmedCheckSequenceId

public void setNextConfirmedCheckSequenceId(Integer nextConfirmedCheckSequenceId)

Sets the nextCheckSequenceId attribute value.

Parameters:

nextCheckSequenceId - The nextCheckSequenceId to set.

getTotalCheckAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalCheckAmount()

Gets the totalCheckAmount attribute.

Returns:

Returns the totalCheckAmount.

getTotalConfirmedCheckAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalConfirmedCheckAmount()

Gets the totalConfirmedCheckAmount attribute.

Returns:

Returns the totalCheckAmount.

getTotalConfirmedCheckAmountForInterim

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalConfirmedCheckAmountForInterim()

Gets the totalConfirmedCheckAmount attribute.

Returns:

Returns the totalCheckAmount.

getCurrencyFormattedTotalCheckAmount

public String getCurrencyFormattedTotalCheckAmount()

This method returns the check total amount as a currency formatted string.

Returns:

String

getCurrencyFormattedTotalConfirmedCheckAmount

public String getCurrencyFormattedTotalConfirmedCheckAmount()

This method returns the confirmed check total amount as a currency formatted string.

Returns:

String

setTotalCheckAmount

public void setTotalCheckAmount(org.kuali.rice.core.api.util.type.KualiDecimal totalCheckAmount)

Sets the totalCheckAmount attribute value.

Parameters:

totalCheckAmount - The totalCheckAmount to set.

setTotalConfirmedCheckAmount

public void setTotalConfirmedCheckAmount(org.kuali.rice.core.api.util.type.KualiDecimal totalConfirmedCheckAmount)

Sets the totalCheckAmount attribute value.

Parameters:

totalCheckAmount - The totalCheckAmount to set.

getTotalCoinAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalCoinAmount()

Gets the totalCoinAmount attribute.

Returns:

Returns the totalCoinAmount.

getTotalConfirmedCoinAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalConfirmedCoinAmount()

Gets the totalConfirmedCoinAmount attribute.

Returns:

Returns the totalConfirmedCoinAmount.

getTotalChangeCoinAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalChangeCoinAmount()

Gets the totalChangeCoinAmount attribute.

Returns:

Returns the totalChangeCoinAmount.

getCurrencyFormattedTotalCoinAmount

public String getCurrencyFormattedTotalCoinAmount()

This method returns the coin total amount as a currency formatted string.

Returns:

String

getCurrencyFormattedTotalConfirmedCoinAmount

public String getCurrencyFormattedTotalConfirmedCoinAmount()

This method returns the confirmed coin total amount as a currency formatted string.

Returns:

String

getGrandTotalConfirmedCashAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getGrandTotalConfirmedCashAmount()

returns (confirmed currency + confirmed coin - change amount)

Returns:

getCurrencyFormattedGrandTotalConfirmedCashAmount

public String getCurrencyFormattedGrandTotalConfirmedCashAmount()

returns (confirmed currency + confirmed coin - change amount) as a currency formatted string

Returns:

setTotalCoinAmount

public void setTotalCoinAmount(org.kuali.rice.core.api.util.type.KualiDecimal totalCoinAmount)

Sets the totalCoinAmount attribute value.

Parameters:

totalCoinAmount - The totalCoinAmount to set.

setTotalConfirmedCoinAmount

public void setTotalConfirmedCoinAmount(org.kuali.rice.core.api.util.type.KualiDecimal totalConfirmedCoinAmount)

Sets the totalConfirmedCoinAmount attribute value.

Parameters:

totalCoinAmount - The totalConfirmedCoinAmount to set.

getTotalDollarAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalDollarAmount()

This method returns the overall total of the document - coin plus check plus cash.

Specified by:

getTotalDollarAmount in interface AmountTotaling

Overrides:

getTotalDollarAmount in class AccountingDocumentBase

Returns:

KualiDecimal

See Also:

AccountingDocumentBase.getTotalDollarAmount()

getTotalConfirmedDollarAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalConfirmedDollarAmount()

This method returns the overall confirmed total of the document - coin plus check plus cash.

Returns:

KualiDecimal

getTotalChangeAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalChangeAmount()

getCoinDetail

public CoinDetail getCoinDetail()

Gets the coinDetail attribute.

Returns:

Returns the coinDetail.

setCoinDetail

public void setCoinDetail(CoinDetail coinDetail)

Sets the coinDetail attribute value.

Parameters:

coinDetail - The coinDetail to set.

getConfirmedCoinDetail

public CoinDetail getConfirmedCoinDetail()

Gets the confirmedCoinDetail attribute.

Returns:

Returns the confirmedCoinDetail.

setConfirmedCoinDetail

public void setConfirmedCoinDetail(CoinDetail coinDetail)

Sets the confirmedCoinDetail attribute value.

Parameters:

coinDetail - The confirmedCoinDetail to set.

getChangeCoinDetail

public CoinDetail getChangeCoinDetail()

Gets the changeCoinDetail attribute.

Returns:

Returns the changeCoinDetail.

setChangeCoinDetail

public void setChangeCoinDetail(CoinDetail changeCoinDetail)

Sets the changeCoinDetail attribute value.

Parameters:

coinDetail - The changeCoinDetail to set.

getCurrencyDetail

public CurrencyDetail getCurrencyDetail()

Gets the currencyDetail attribute.

Returns:

Returns the currencyDetail.

setCurrencyDetail

public void setCurrencyDetail(CurrencyDetail currencyDetail)

Sets the currencyDetail attribute value.

Parameters:

currencyDetail - The currencyDetail to set.

getConfirmedCurrencyDetail

public CurrencyDetail getConfirmedCurrencyDetail()

Gets the confirmedCurrencyDetail attribute.

Returns:

Returns the confirmedCurrencyDetail.

setConfirmedCurrencyDetail

public void setConfirmedCurrencyDetail(CurrencyDetail confirmedCurrencyDetail)

Sets the confirmedCurrencyDetail attribute value.

Parameters:

currencyDetail - The confirmedCurrencyDetail to set.

getChangeCurrencyDetail

public CurrencyDetail getChangeCurrencyDetail()

Gets the changeCurrencyDetail attribute.

Returns:

Returns the changeCurrencyDetail.

setChangeCurrencyDetail

public void setChangeCurrencyDetail(CurrencyDetail changeCurrencyDetail)

Sets the changeCurrencyDetail attribute value.

Parameters:

currencyDetail - The changeCurrencyDetail to set.

getCurrencyFormattedSumTotalAmount

public String getCurrencyFormattedSumTotalAmount()

Retrieves the summed total amount in a currency format with commas.

Returns:

String

getCurrencyFormattedConfirmedSumTotalAmount

public String getCurrencyFormattedConfirmedSumTotalAmount()

Retrieves the confirmed summed total amount in a currency format with commas.

Returns:

String

getCurrencyFormattedFinalSumTotalAmount

public String getCurrencyFormattedFinalSumTotalAmount()

Retrieves the final summed total amount (after subtracting change amount)in currency format with commas.

Returns:

String

getCurrencyFormattedChangeTotalAmount

public String getCurrencyFormattedChangeTotalAmount()

Retrieves the change total amount in a currency format with commas.

Returns:

String

isRecategorized

public boolean isRecategorized()

Gets the recategorized attribute.

Returns:

Returns the recategorized.

setRecategorized

public void setRecategorized(boolean recategorized)

Sets the recategorized attribute value.

Parameters:

recategorized - The recategorized to set.

calculateCheckTotal

public org.kuali.rice.core.api.util.type.KualiDecimal calculateCheckTotal()

Returns:

sum of the amounts of the current list of checks

calculateConfirmedCheckTotal

public org.kuali.rice.core.api.util.type.KualiDecimal calculateConfirmedCheckTotal()

Returns:

sum of the amounts of the current list of checks

prepareForSave

public void prepareForSave()

Description copied from class: FinancialSystemTransactionalDocumentBase

If the document has a total amount, call method on document to get the total and set in doc header.

Specified by:

prepareForSave in interface org.kuali.rice.krad.document.Document

Overrides:

prepareForSave in class FinancialSystemTransactionalDocumentBase

See Also:

org.kuali.rice.kns.document.DocumentBase#prepareForSave()

processAfterRetrieve

public void processAfterRetrieve()

Description copied from class: FinancialSystemTransactionalDocumentBase

This is the default implementation which ensures that document note attachment references are loaded.

Specified by:

processAfterRetrieve in interface org.kuali.rice.krad.document.Document

Overrides:

processAfterRetrieve in class FinancialSystemTransactionalDocumentBase

See Also:

org.kuali.rice.kns.document.DocumentBase#processAfterRetrieve()

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)

Override to set the document status to VERIFIED ("V") when the document is FINAL. When the Cash Management document that this is associated with is FINAL approved, this status will be set to APPROVED ("A") to be picked up by the GL for processing. That's done in the doRouteStatusChange() method in the CashManagementDocument.

Specified by:

doRouteStatusChange in interface org.kuali.rice.krad.document.Document

Overrides:

doRouteStatusChange in class CapitalAssetInformationDocumentBase

See Also:

org.kuali.rice.kns.document.Document#doRouteStatusChange()

postProcessSave

public void postProcessSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)

Specified by:

postProcessSave in interface org.kuali.rice.krad.document.Document

Overrides:

postProcessSave in class org.kuali.rice.krad.document.DocumentBase

See Also:

org.kuali.rice.kns.document.DocumentBase#postProcessSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent)

refreshCashDetails

public void refreshCashDetails()

This method refreshes the currency/coin details for this cash receipt document

retrieveCurrencyDetail

protected CurrencyDetail retrieveCurrencyDetail()

Get this document's currency detail from the database

Returns:

the currency detail record for this cash receipt document

retrieveCoinDetail

protected CoinDetail retrieveCoinDetail()

Grab this document's coin detail from the database

Returns:

the coin detail record for this cash receipt document

retrieveConfirmedCurrencyDetail

protected CurrencyDetail retrieveConfirmedCurrencyDetail()

Get this document's confirmed currency detail from the database

Returns:

the currency detail record for this cash receipt document

retrieveConfirmedCoinDetail

protected CoinDetail retrieveConfirmedCoinDetail()

Get this document's confirmed coin detail from the database

Returns:

the coin detail record for this cash receipt document

retrieveChangeCurrencyDetail

protected CurrencyDetail retrieveChangeCurrencyDetail()

Get this document's change currency detail from the database

Returns:

the change currency detail record for this cash receipt document

retrieveChangeCoinDetail

protected CoinDetail retrieveChangeCoinDetail()

Get this document's change coin detail from the database

Returns:

the change coin detail record for this cash receipt document

getCreateDate

public String getCreateDate()

This method...

Returns:

getCashDetailPrimaryKey

protected Map getCashDetailPrimaryKey()

Generate the primary key for a currency or coin detail related to this document

Returns:

a map with a representation of the proper primary key

getConfirmedCashDetailPrimaryKey

protected Map getConfirmedCashDetailPrimaryKey()

getChangeCashDetailPrimaryKey

protected Map getChangeCashDetailPrimaryKey()

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Specified by:

buildListOfDeletionAwareLists in interface org.kuali.rice.krad.bo.PersistableBusinessObject

Overrides:

buildListOfDeletionAwareLists in class CapitalAssetInformationDocumentBase

See Also:

org.kuali.rice.kns.document.TransactionalDocumentBase#buildListOfDeletionAwareLists()

generateSaveEvents

public List generateSaveEvents()

Specified by:

generateSaveEvents in interface org.kuali.rice.krad.document.Document

Overrides:

generateSaveEvents in class AccountingDocumentBase

generateEvents

protected List generateEvents(Collection persistedChecks,
                  List currentChecks,
                  String errorPathPrefix,
                  CashReceiptFamilyBase crdoc)

Generates a List of instances of CheckEvent subclasses, one for each changed check in the union of the persistedLines and currentLines lists. Events in the list will be grouped in order by event-type (update, add, delete).

Parameters:

persistedChecks -

currentChecks -

errorPathPrefix -

crdoc -

Returns:

List of CheckEvent subclass instances

buildCheckMap

protected Map buildCheckMap(Collection checks)

Parameters:

checks -

Returns:

Map containing Checks from the given List, indexed by their sequenceId

createNewCheck

public Check createNewCheck()

createNewConfirmedCheck

public Check createNewConfirmedCheck()

getDepositCashReceiptControl

public List getDepositCashReceiptControl()

Gets the depositCashReceiptControl attribute.

Returns:

Returns the depositCashReceiptControl.

setDepositCashReceiptControl

public void setDepositCashReceiptControl(List depositCashReceiptControl)

Sets the depositCashReceiptControl attribute value.

Parameters:

depositCashReceiptControl - The depositCashReceiptControl to set.

toCopy

public void toCopy()
            throws org.kuali.rice.kew.api.exception.WorkflowException

Override the campus code on the copied document to whatever the campus of the copying user is

Specified by:

toCopy in interface org.kuali.rice.krad.document.Copyable

Overrides:

toCopy in class AccountingDocumentBase

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

AccountingDocumentBase.toCopy()

initializeCampusLocationCode

public void initializeCampusLocationCode()

Initializes the campus location code based on ole user role chart org

getSumTotalAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getSumTotalAmount()

Gets the sumTotalAmount attribute.

Returns:

Returns the sumTotalAmount

setSumTotalAmount

public void setSumTotalAmount(org.kuali.rice.core.api.util.type.KualiDecimal sumTotalAmount)

Sets the sumTotalAmount attribute.

Parameters:

sumTotalAmount - The sumTotalAmount to set.