org.kuali.kfs.fp.document
Class CashManagementDocument

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.rice.kns.document.DocumentBase
              org.kuali.rice.kns.document.TransactionalDocumentBase
                  org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase
                      org.kuali.kfs.sys.document.LedgerPostingDocumentBase
                          org.kuali.kfs.sys.document.GeneralLedgerPostingDocumentBase
                              org.kuali.kfs.fp.document.CashManagementDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, FinancialSystemTransactionalDocument, GeneralLedgerPendingEntrySource, GeneralLedgerPostingDocument, LedgerPostingDocument, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.bo.PersistableBusinessObject, org.kuali.rice.kns.document.Document, org.kuali.rice.kns.document.SessionDocument, org.kuali.rice.kns.document.TransactionalDocument

public class CashManagementDocument
extends GeneralLedgerPostingDocumentBase
implements GeneralLedgerPendingEntrySource

This class represents the CashManagementDocument.

See Also:

Serialized Form

Field Summary

protected org.kuali.rice.kns.bo.Campus	campus
protected String	campusCode
protected CashDrawer	cashDrawer
protected List<Check>	checks
protected CashieringTransaction	currentTransaction
protected List<Deposit>	deposits
protected static org.apache.log4j.Logger	LOG
protected String	referenceFinancialDocumentNumber
protected static long	serialVersionUID

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

generalLedgerPendingEntries

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

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

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

documentHeader

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

documentBusinessObject, documentNumber

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

extension, versionNumber

Constructor Summary

CashManagementDocument()
Default constructor.

Method Summary

void	addCheck(Check check) Add a check to the cash management document
List	buildListOfDeletionAwareLists()
protected static String	createDescription(Deposit deposit, int interimDepositNumber) Create description for deposit
void	customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable, GeneralLedgerPendingEntry explicitEntry) Does nothing, as there aren't any accounting lines on this doc, so no GeneralLedgerPendingEntrySourceDetail create GLPEs
boolean	customizeOffsetGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail accountingLine, GeneralLedgerPendingEntry explicitEntry, GeneralLedgerPendingEntry offsetEntry) Does nothing save return true, as this document has no GLPEs created from a source of GeneralLedgerPostables
void	doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent) Override to call super and then iterate over all GLPEs and update the approved code appropriately.
protected void	extendDeposits(int minSize) Adds default AccountingLineDecorators to sourceAccountingLineDecorators until it contains at least minSize elements
boolean	generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper) Generates bank offset GLPEs for deposits, if enabled.
boolean	generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail, GeneralLedgerPendingEntrySequenceHelper sequenceHelper) The Cash Management doc doesn't have accounting lines, so it doesn't create general ledger pending entries for the accounting lines it doesn't have
boolean	getBankCashOffsetEnabled() Helper method on document for determining whether the document can have GLPEs.
org.kuali.rice.kns.bo.Campus	getCampus()
String	getCampusCode()
CashDrawer	getCashDrawer() Gets the cashDrawer attribute.
String	getCashDrawerStatus() Derives and returns the cash drawer status for the document's workgroup
List<Check>	getChecks() Gets the checks attribute.
CashieringTransaction	getCurrentTransaction() Gets the currentTransaction attribute.
Deposit	getDeposit(int index) Implementation creates empty Deposits as a side-effect, so that Struts' efforts to set fields of lines which haven't been created will succeed rather than causing a NullPointerException.
List<Deposit>	getDeposits()
org.kuali.rice.kns.util.KualiDecimal	getGeneralLedgerPendingEntryAmountForDetail(GeneralLedgerPendingEntrySourceDetail postable) A method to determine what the actual amount, based off of a GeneralLedgerPendingEntrySourceDetail, should be for the resultant GeneralLedgerPendingEntry
List<GeneralLedgerPendingEntrySourceDetail>	getGeneralLedgerPendingEntrySourceDetails() Returns an empty list as this document has no GeneralLedgerPostables
Integer	getNextDepositLineNumber()
String	getRawCashDrawerStatus() Alias for getCashDrawerStatus which avoids the automagic formatting
String	getReferenceFinancialDocumentNumber()
protected Integer	getUniversityFiscalYear() Gets the fiscal year for the GLPEs generated by this document.
boolean	hasFinalDeposit()
boolean	isDebit(GeneralLedgerPendingEntrySourceDetail postable) Always returns true, as there are no GeneralLedgerPostables to create GLPEs
protected void	logState()
void	prepareForSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent event)
void	processAfterRetrieve() This is the default implementation which ensures that document note attachment references are loaded.
Deposit	removeDeposit(int index) Removes and returns the Deposit at the given index.
void	resetCurrentTransaction() This method creates a clean current transaction to be the new current transaction on this document
protected org.kuali.rice.kns.bo.Campus	retrieveCampus()
void	setCampusCode(String campusCode) Sets the campusCode attribute value.
void	setCashDrawer(CashDrawer cd) Sets the cashDrawer attribute
void	setCashDrawerStatus(String cashDrawerStatus)
void	setChecks(List<Check> checks) Sets the checks attribute value.
void	setCurrentTransaction(CashieringTransaction currentTransaction) Sets the currentTransaction attribute value.
void	setDeposits(List<Deposit> deposits) Sets the current List of Deposits
void	setReferenceFinancialDocumentNumber(String referenceFinancialDocumentNumber) Sets the referenceFinancialDocumentNumber attribute value.
protected LinkedHashMap	toStringMapper()

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

addPendingEntry, changeGeneralLedgerPendingEntriesApprovedStatusCode, checkSufficientFunds, clearAnyGeneralLedgerPendingEntries, documentPerformsSufficientFundsCheck, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, removeGeneralLedgerPendingEntries, setGeneralLedgerPendingEntries, toCopy, toErrorCorrection

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

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

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

answerSplitNodeQuestion, getDocumentHeader, prepareForSave, setDocumentHeader

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

getAllowsCopy, isSessionDocument

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

addCopyErrorDocumentNote, addPessimisticLock, afterLookup, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postProcessSave, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentNumber, setNewDocumentHeader, setPessimisticLocks, toString, toStringBuilder, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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

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

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

prepareForWorkflow

Methods inherited from class java.lang.Object

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

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

addPendingEntry, clearAnyGeneralLedgerPendingEntries, getDocumentHeader, getFinancialDocumentTypeCode, getPostingYear

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

getAccountingPeriod, getPostingPeriodCode, getPostingYear, setAccountingPeriod, setPostingPeriodCode, setPostingYear

Methods inherited from interface org.kuali.kfs.sys.document.FinancialSystemTransactionalDocument

answerSplitNodeQuestion, getDocumentHeader

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

addPessimisticLock, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, refreshPessimisticLocks, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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

addNote, deleteNote, getBoNote, getBoNotes, getExtension, getObjectId, getVersionNumber, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setAutoIncrementSet, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

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

prepareForWorkflow, refresh

Methods inherited from interface org.apache.ojb.broker.PersistenceBrokerAware

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate

Field Detail

serialVersionUID

protected static final long serialVersionUID

See Also:

Constant Field Values

LOG

protected static org.apache.log4j.Logger LOG

campusCode

protected String campusCode

referenceFinancialDocumentNumber

protected String referenceFinancialDocumentNumber

deposits

protected List<Deposit> deposits

checks

protected List<Check> checks

currentTransaction

protected CashieringTransaction currentTransaction

cashDrawer

protected CashDrawer cashDrawer

campus

protected org.kuali.rice.kns.bo.Campus campus

Constructor Detail

CashManagementDocument

public CashManagementDocument()

Default constructor.

Method Detail

getReferenceFinancialDocumentNumber

public String getReferenceFinancialDocumentNumber()

Returns:

current value of referenceFinancialDocumentNumber.

setReferenceFinancialDocumentNumber

public void setReferenceFinancialDocumentNumber(String referenceFinancialDocumentNumber)

Sets the referenceFinancialDocumentNumber attribute value.

Parameters:

referenceFinancialDocumentNumber - The referenceFinancialDocumentNumber to set.

getCampusCode

public String getCampusCode()

Returns:

current value of campusCode.

setCampusCode

public void setCampusCode(String campusCode)

Sets the campusCode attribute value.

Parameters:

campusCode - The campusCode to set.

getCashDrawerStatus

public String getCashDrawerStatus()

Derives and returns the cash drawer status for the document's workgroup

setCashDrawerStatus

public void setCashDrawerStatus(String cashDrawerStatus)

Parameters:

cashDrawerStatus -

getRawCashDrawerStatus

public String getRawCashDrawerStatus()

Alias for getCashDrawerStatus which avoids the automagic formatting

getDeposits

public List<Deposit> getDeposits()

Returns:

current List of Deposits

setDeposits

public void setDeposits(List<Deposit> deposits)

Sets the current List of Deposits

Parameters:

deposits -

getDeposit

public Deposit getDeposit(int index)

Implementation creates empty Deposits as a side-effect, so that Struts' efforts to set fields of lines which haven't been created will succeed rather than causing a NullPointerException.

Returns:

Deposit at the given index

removeDeposit

public Deposit removeDeposit(int index)

Removes and returns the Deposit at the given index.

Parameters:

index -

Returns:

Deposit at the given index

hasFinalDeposit

public boolean hasFinalDeposit()

Returns:

true if one of the Deposits contained in this document has a type of "final"

getNextDepositLineNumber

public Integer getNextDepositLineNumber()

Returns:

lowest unused deposit-line-number, to simplify adding and canceling deposits out-of-order

extendDeposits

protected void extendDeposits(int minSize)

Adds default AccountingLineDecorators to sourceAccountingLineDecorators until it contains at least minSize elements

Parameters:

minSize -

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Specified by:

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

Overrides:

buildListOfDeletionAwareLists in class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

See Also:

PersistableBusinessObjectBase.buildListOfDeletionAwareLists()

getCashDrawer

public CashDrawer getCashDrawer()

Gets the cashDrawer attribute.

Returns:

Returns the cashDrawer.

setCashDrawer

public void setCashDrawer(CashDrawer cd)

Sets the cashDrawer attribute

Parameters:

cd - the cash drawer to set

getCurrentTransaction

public CashieringTransaction getCurrentTransaction()

Gets the currentTransaction attribute.

Returns:

Returns the currentTransaction.

setCurrentTransaction

public void setCurrentTransaction(CashieringTransaction currentTransaction)

Sets the currentTransaction attribute value.

Parameters:

currentTransaction - The currentTransaction to set.

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.

addCheck

public void addCheck(Check check)

Add a check to the cash management document

Parameters:

check -

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent)

Description copied from class: GeneralLedgerPostingDocumentBase

Override to call super and then iterate over all GLPEs and update the approved code appropriately.

Specified by:

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

Overrides:

doRouteStatusChange in class GeneralLedgerPostingDocumentBase

See Also:

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

logState

protected void logState()

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.kns.document.Document

Overrides:

processAfterRetrieve in class FinancialSystemTransactionalDocumentBase

See Also:

DocumentBase.processAfterRetrieve()

toStringMapper

protected LinkedHashMap toStringMapper()

Overrides:

toStringMapper in class org.kuali.rice.kns.document.DocumentBase

See Also:

BusinessObjectBase.toStringMapper()

resetCurrentTransaction

public void resetCurrentTransaction()

This method creates a clean current transaction to be the new current transaction on this document

customizeExplicitGeneralLedgerPendingEntry

public void customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable,
                                                       GeneralLedgerPendingEntry explicitEntry)

Does nothing, as there aren't any accounting lines on this doc, so no GeneralLedgerPendingEntrySourceDetail create GLPEs

See Also:

org.kuali.kfs.document.GeneralLedgerPostingHelper#customizeExplicitGeneralLedgerPendingEntry(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail, org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntry)

customizeOffsetGeneralLedgerPendingEntry

public boolean customizeOffsetGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail accountingLine,
                                                        GeneralLedgerPendingEntry explicitEntry,
                                                        GeneralLedgerPendingEntry offsetEntry)

Does nothing save return true, as this document has no GLPEs created from a source of GeneralLedgerPostables

See Also:

org.kuali.kfs.document.GeneralLedgerPostingHelper#customizeOffsetGeneralLedgerPendingEntry(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail, org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntry, org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntry)

getGeneralLedgerPendingEntrySourceDetails

public List<GeneralLedgerPendingEntrySourceDetail> getGeneralLedgerPendingEntrySourceDetails()

Returns an empty list as this document has no GeneralLedgerPostables

Specified by:

getGeneralLedgerPendingEntrySourceDetails in interface GeneralLedgerPendingEntrySource

Returns:

a list of GeneralLedgerPostables

See Also:

org.kuali.kfs.document.GeneralLedgerPostingHelper#getGeneralLedgerPostables()

isDebit

public boolean isDebit(GeneralLedgerPendingEntrySourceDetail postable)

Always returns true, as there are no GeneralLedgerPostables to create GLPEs

Specified by:

isDebit in interface GeneralLedgerPendingEntrySource

Returns:

true if the given GeneralLedgerPendingEntrySourceDetail is a debit, false if it is a credit

See Also:

org.kuali.kfs.document.GeneralLedgerPostingHelper#isDebit(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail)

generateDocumentGeneralLedgerPendingEntries

public boolean generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

Generates bank offset GLPEs for deposits, if enabled.

Specified by:

generateDocumentGeneralLedgerPendingEntries in interface GeneralLedgerPendingEntrySource

Parameters:

financialDocument - submitted accounting document

sequenceHelper - helper class to keep track of sequence of general ledger pending entries

Returns:

true if the pending entries were able to be successfully created and added to this GeneralLedgerPendingEntrySource; false if an error condition occurred with mean that GLPEs were not correctly generated

See Also:

org.kuali.kfs.document.GeneralLedgerPostingHelper#processGenerateDocumentGeneralLedgerPendingEntries(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySequenceHelper)

createDescription

protected static String createDescription(Deposit deposit,
                                          int interimDepositNumber)

Create description for deposit

Parameters:

deposit - deposit from cash management document

interimDepositNumber -

Returns:

the description for the given deposit's GLPE bank offset

getUniversityFiscalYear

protected Integer getUniversityFiscalYear()

Gets the fiscal year for the GLPEs generated by this document. This works the same way as in TransactionalDocumentBase. The property is down in TransactionalDocument because no FinancialDocument (currently only CashManagementDocument) allows the user to override it. So, that logic is duplicated here. A comment in TransactionalDocumentBase says that this implementation is a hack right now because it's intended to be set by the AccountingPeriodService, which suggests to me that pulling that property up to FinancialDocument is preferable to duplicating this logic here.

Returns:

the fiscal year for the GLPEs generated by this document

generateGeneralLedgerPendingEntries

public boolean generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
                                                   GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

The Cash Management doc doesn't have accounting lines, so it doesn't create general ledger pending entries for the accounting lines it doesn't have

Specified by:

generateGeneralLedgerPendingEntries in interface GeneralLedgerPendingEntrySource

Parameters:

glpeSourceDetail - the source detail line to generate general ledger pending entries for

sequenceHelper - the sequence helper which will assign sequence number to generated general ledger pending entries

Returns:

true if general ledger pending entry generation was successful; false if an error condition prevented the successful generation of the pending entries

See Also:

GeneralLedgerPendingEntrySource.generateGeneralLedgerPendingEntries(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail, org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySequenceHelper)

getGeneralLedgerPendingEntryAmountForDetail

public org.kuali.rice.kns.util.KualiDecimal getGeneralLedgerPendingEntryAmountForDetail(GeneralLedgerPendingEntrySourceDetail postable)

Description copied from interface: GeneralLedgerPendingEntrySource

A method to determine what the actual amount, based off of a GeneralLedgerPendingEntrySourceDetail, should be for the resultant GeneralLedgerPendingEntry

Specified by:

getGeneralLedgerPendingEntryAmountForDetail in interface GeneralLedgerPendingEntrySource

Parameters:

postable - the detail line from the general ledger pending entry source to find an amount for

Returns:

The amount that will be used to populate the amount on the generated general ledger pending entry for the given source detail

See Also:

org.kuali.kfs.sys.document.GeneralLedgerPendingEntrySource#getGeneralLedgerPendingEntryAmountForGeneralLedgerPostable(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail)

getBankCashOffsetEnabled

public boolean getBankCashOffsetEnabled()

Helper method on document for determining whether the document can have GLPEs.

Returns:

true if document can have GLPEs

prepareForSave

public void prepareForSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent event)

Specified by:

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

Overrides:

prepareForSave in class GeneralLedgerPostingDocumentBase

See Also:

GeneralLedgerPostingDocumentBase.prepareForSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent)

getCampus

public org.kuali.rice.kns.bo.Campus getCampus()

Returns:

the campus associated with this cash drawer

retrieveCampus

protected org.kuali.rice.kns.bo.Campus retrieveCampus()