org.kuali.kfs.fp.document
Class CashReceiptDocument

java.lang.Object
  extended by org.kuali.rice.kns.bo.BusinessObjectBase
      extended by org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          extended by org.kuali.rice.kns.document.DocumentBase
              extended by org.kuali.rice.kns.document.TransactionalDocumentBase
                  extended by org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase
                      extended by org.kuali.kfs.sys.document.LedgerPostingDocumentBase
                          extended by org.kuali.kfs.sys.document.GeneralLedgerPostingDocumentBase
                              extended by org.kuali.kfs.sys.document.AccountingDocumentBase
                                  extended by org.kuali.kfs.fp.document.CashReceiptFamilyBase
                                      extended by org.kuali.kfs.fp.document.CashReceiptDocument
All Implemented Interfaces:
Serializable, org.apache.ojb.broker.PersistenceBrokerAware, CapitalAssetEditable, AccountingDocument, AmountTotaling, FinancialSystemTransactionalDocument, GeneralLedgerPendingEntrySource, GeneralLedgerPostingDocument, LedgerPostingDocument, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.bo.PersistableBusinessObject, org.kuali.rice.kns.document.Copyable, org.kuali.rice.kns.document.Document, org.kuali.rice.kns.document.SessionDocument, org.kuali.rice.kns.document.TransactionalDocument

public class CashReceiptDocument
extends CashReceiptFamilyBase
implements org.kuali.rice.kns.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
static String CHECK_ENTRY_DETAIL
           
static String CHECK_ENTRY_TOTAL
           
protected  String checkEntryMode
           
protected  List checks
           
protected  CoinDetail coinDetail
           
protected  CurrencyDetail currencyDetail
           
protected  List depositCashReceiptControl
           
static String DOCUMENT_TYPE
           
protected static org.apache.log4j.Logger LOG
           
protected  Integer nextCheckSequenceId
           
protected  org.kuali.rice.kns.util.KualiDecimal totalCashAmount
           
protected  org.kuali.rice.kns.util.KualiDecimal totalCheckAmount
           
protected  org.kuali.rice.kns.util.KualiDecimal totalCoinAmount
           
 
Fields inherited from class org.kuali.kfs.fp.document.CashReceiptFamilyBase
campusLocationCode, capitalAssetInformation, depositDate
 
Fields inherited from class org.kuali.kfs.sys.document.AccountingDocumentBase
dataDictionaryEntry, nextSourceLineNumber, nextTargetLineNumber, sourceAccountingLineClass, sourceAccountingLines, targetAccountingLineClass, targetAccountingLines
 
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
CashReceiptDocument()
          Initializes the array lists and line incrementers.
 
Method Summary
 void addCheck(Check check)
          Adds a new check to the list.
protected  Map buildCheckMap(List checks)
           
 List buildListOfDeletionAwareLists()
           
 org.kuali.rice.kns.util.KualiDecimal calculateCheckTotal()
           
 List<SufficientFundsItem> checkSufficientFunds()
          This method will check sufficient funds for the document
 Check createNewCheck()
           
 void doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent)
          Override to set the document status to VERIFIED ("V") when the document is FINAL.
protected  List generateEvents(List 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
 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.
 CurrencyDetail getCurrencyDetail()
          Gets the currencyDetail attribute.
 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.
 List getDepositCashReceiptControl()
          Gets the depositCashReceiptControl attribute.
 Integer getNextCheckSequenceId()
          Gets the nextCheckSequenceId attribute.
 org.kuali.rice.kns.util.KualiDecimal getTotalCashAmount()
          Gets the totalCashAmount attribute.
 org.kuali.rice.kns.util.KualiDecimal getTotalCheckAmount()
          Gets the totalCheckAmount attribute.
 org.kuali.rice.kns.util.KualiDecimal getTotalCoinAmount()
          Gets the totalCoinAmount attribute.
 org.kuali.rice.kns.util.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 kfs user role chart org
 void postProcessSave(org.kuali.rice.kns.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.
protected  CoinDetail retrieveCoinDetail()
          Grab this document's coin detail from the database
protected  CurrencyDetail retrieveCurrencyDetail()
          Get this document's currency detail from the database
 void setCheckEntryMode(String checkEntryMode)
           
 void setChecks(List checks)
          Sets the checks attribute value.
 void setCoinDetail(CoinDetail coinDetail)
          Sets the coinDetail 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 setTotalCashAmount(org.kuali.rice.kns.util.KualiDecimal cashAmount)
          Sets the totalCashAmount attribute value.
 void setTotalCheckAmount(org.kuali.rice.kns.util.KualiDecimal totalCheckAmount)
          Sets the totalCheckAmount attribute value.
 void setTotalCoinAmount(org.kuali.rice.kns.util.KualiDecimal totalCoinAmount)
          Sets the totalCoinAmount 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.kfs.fp.document.CashReceiptFamilyBase
customizeExplicitGeneralLedgerPendingEntry, documentPerformsSufficientFundsCheck, getCampusLocationCode, getCapitalAssetInformation, getCapitalAssetManagementModuleService, getDepositDate, getSourceAccountingLinesSectionTitle, getSourceTotal, getTargetAccountingLinesSectionTitle, getTargetTotal, isDebit, setCampusLocationCode, setCapitalAssetInformation, setDepositDate
 
Methods inherited from class org.kuali.kfs.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, prepareForSave, processExplicitGeneralLedgerPendingEntry, processOffsetGeneralLedgerPendingEntry, setNextSourceLineNumber, setNextTargetLineNumber, setSourceAccountingLines, setTargetAccountingLines, toErrorCorrection, updatePostingYearForAccountingLines
 
Methods inherited from class org.kuali.kfs.sys.document.GeneralLedgerPostingDocumentBase
addPendingEntry, changeGeneralLedgerPendingEntriesApprovedStatusCode, clearAnyGeneralLedgerPendingEntries, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, removeGeneralLedgerPendingEntries, setGeneralLedgerPendingEntries
 
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, 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, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentNumber, setNewDocumentHeader, setPessimisticLocks, toString, toStringBuilder, toStringMapper, 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.fp.document.CapitalAssetEditable
getCapitalAssetInformation, setCapitalAssetInformation
 
Methods inherited from interface org.kuali.kfs.sys.document.GeneralLedgerPostingDocument
getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, setGeneralLedgerPendingEntries
 
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, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, 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
 
Methods inherited from interface org.kuali.kfs.sys.document.GeneralLedgerPendingEntrySource
addPendingEntry, clearAnyGeneralLedgerPendingEntries, getDocumentHeader, getFinancialDocumentTypeCode, getPostingYear
 

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

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 checks

depositCashReceiptControl

protected List depositCashReceiptControl

nextCheckSequenceId

protected Integer nextCheckSequenceId

totalCashAmount

protected org.kuali.rice.kns.util.KualiDecimal totalCashAmount

totalCheckAmount

protected org.kuali.rice.kns.util.KualiDecimal totalCheckAmount

totalCoinAmount

protected org.kuali.rice.kns.util.KualiDecimal totalCoinAmount

currencyDetail

protected CurrencyDetail currencyDetail

coinDetail

protected CoinDetail coinDetail
Constructor Detail

CashReceiptDocument

public CashReceiptDocument()
Initializes the array lists and line incrementers.

Method Detail

getTotalCashAmount

public org.kuali.rice.kns.util.KualiDecimal getTotalCashAmount()
Gets the totalCashAmount attribute.

Returns:
Returns the totalCashAmount.

getCurrencyFormattedTotalCashAmount

public String getCurrencyFormattedTotalCashAmount()
This method returns the cash total amount as a currency formatted string.

Returns:
String

setTotalCashAmount

public void setTotalCashAmount(org.kuali.rice.kns.util.KualiDecimal cashAmount)
Sets the totalCashAmount attribute value.

Parameters:
cashAmount - The totalCashAmount 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 checks)
Sets the checks attribute value.

Parameters:
checks - 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

addCheck

public void addCheck(Check check)
Adds a new 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

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 -

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.

getTotalCheckAmount

public org.kuali.rice.kns.util.KualiDecimal getTotalCheckAmount()
Gets the totalCheckAmount attribute.

Returns:
Returns the totalCheckAmount.

getCurrencyFormattedTotalCheckAmount

public String getCurrencyFormattedTotalCheckAmount()
This method returns the check total amount as a currency formatted string.

Returns:
String

setTotalCheckAmount

public void setTotalCheckAmount(org.kuali.rice.kns.util.KualiDecimal totalCheckAmount)
Sets the totalCheckAmount attribute value.

Parameters:
totalCheckAmount - The totalCheckAmount to set.

getTotalCoinAmount

public org.kuali.rice.kns.util.KualiDecimal getTotalCoinAmount()
Gets the totalCoinAmount attribute.

Returns:
Returns the totalCoinAmount.

getCurrencyFormattedTotalCoinAmount

public String getCurrencyFormattedTotalCoinAmount()
This method returns the coin total amount as a currency formatted string.

Returns:
String

setTotalCoinAmount

public void setTotalCoinAmount(org.kuali.rice.kns.util.KualiDecimal totalCoinAmount)
Sets the totalCoinAmount attribute value.

Parameters:
totalCoinAmount - The totalCoinAmount to set.

getTotalDollarAmount

public org.kuali.rice.kns.util.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()

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.

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.

getCurrencyFormattedSumTotalAmount

public String getCurrencyFormattedSumTotalAmount()
Retrieves the summed total amount in a currency format with commas.

Returns:
String

calculateCheckTotal

public org.kuali.rice.kns.util.KualiDecimal calculateCheckTotal()
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.kns.document.Document
Overrides:
prepareForSave in class FinancialSystemTransactionalDocumentBase
See Also:
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.kns.document.Document
Overrides:
processAfterRetrieve in class FinancialSystemTransactionalDocumentBase
See Also:
DocumentBase.processAfterRetrieve()

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO 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.kns.document.Document
Overrides:
doRouteStatusChange in class GeneralLedgerPostingDocumentBase
See Also:
org.kuali.rice.kns.document.Document#doRouteStatusChange()

postProcessSave

public void postProcessSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent event)
Specified by:
postProcessSave in interface org.kuali.rice.kns.document.Document
Overrides:
postProcessSave in class org.kuali.rice.kns.document.DocumentBase
See Also:
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

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

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()
Specified by:
buildListOfDeletionAwareLists in interface org.kuali.rice.kns.bo.PersistableBusinessObject
Overrides:
buildListOfDeletionAwareLists in class CashReceiptFamilyBase
See Also:
PersistableBusinessObjectBase.buildListOfDeletionAwareLists()

generateSaveEvents

public List generateSaveEvents()
Specified by:
generateSaveEvents in interface org.kuali.rice.kns.document.Document
Overrides:
generateSaveEvents in class AccountingDocumentBase

generateEvents

protected List generateEvents(List 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(List checks)
Parameters:
checks -
Returns:
Map containing Checks from the given List, indexed by their sequenceId

createNewCheck

public Check createNewCheck()

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.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.kns.document.Copyable
Overrides:
toCopy in class AccountingDocumentBase
Throws:
org.kuali.rice.kew.exception.WorkflowException
See Also:
AccountingDocumentBase.toCopy()

initializeCampusLocationCode

public void initializeCampusLocationCode()
Initializes the campus location code based on kfs user role chart org



Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.