|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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.sys.document.AccountingDocumentBase
org.kuali.kfs.fp.document.CashReceiptFamilyBase
org.kuali.kfs.fp.document.CashReceiptDocument
public class CashReceiptDocument
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.
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.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 |
---|
protected static org.apache.log4j.Logger LOG
public static final String CHECK_ENTRY_DETAIL
public static final String CHECK_ENTRY_TOTAL
public static final String DOCUMENT_TYPE
protected String checkEntryMode
protected List checks
protected List depositCashReceiptControl
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
protected CurrencyDetail currencyDetail
protected CoinDetail coinDetail
Constructor Detail |
---|
public CashReceiptDocument()
Method Detail |
---|
public org.kuali.rice.kns.util.KualiDecimal getTotalCashAmount()
public String getCurrencyFormattedTotalCashAmount()
public void setTotalCashAmount(org.kuali.rice.kns.util.KualiDecimal cashAmount)
cashAmount
- The totalCashAmount to set.public void setCheckEntryMode(String checkEntryMode)
checkEntryMode
- public String getCheckEntryMode()
public List<Check> getChecks()
public void setChecks(List checks)
checks
- The checks to set.public int getCheckCount()
public void addCheck(Check check)
check
- public Check getCheck(int index)
index
-
public List<SufficientFundsItem> checkSufficientFunds()
GeneralLedgerPostingDocument
checkSufficientFunds
in interface GeneralLedgerPostingDocument
checkSufficientFunds
in class GeneralLedgerPostingDocumentBase
GeneralLedgerPostingDocumentBase.checkSufficientFunds()
public void removeCheck(int index)
index
- public Integer getNextCheckSequenceId()
public void setNextCheckSequenceId(Integer nextCheckSequenceId)
nextCheckSequenceId
- The nextCheckSequenceId to set.public org.kuali.rice.kns.util.KualiDecimal getTotalCheckAmount()
public String getCurrencyFormattedTotalCheckAmount()
public void setTotalCheckAmount(org.kuali.rice.kns.util.KualiDecimal totalCheckAmount)
totalCheckAmount
- The totalCheckAmount to set.public org.kuali.rice.kns.util.KualiDecimal getTotalCoinAmount()
public String getCurrencyFormattedTotalCoinAmount()
public void setTotalCoinAmount(org.kuali.rice.kns.util.KualiDecimal totalCoinAmount)
totalCoinAmount
- The totalCoinAmount to set.public org.kuali.rice.kns.util.KualiDecimal getTotalDollarAmount()
getTotalDollarAmount
in interface AmountTotaling
getTotalDollarAmount
in class AccountingDocumentBase
AccountingDocumentBase.getTotalDollarAmount()
public CoinDetail getCoinDetail()
public void setCoinDetail(CoinDetail coinDetail)
coinDetail
- The coinDetail to set.public CurrencyDetail getCurrencyDetail()
public void setCurrencyDetail(CurrencyDetail currencyDetail)
currencyDetail
- The currencyDetail to set.public String getCurrencyFormattedSumTotalAmount()
public org.kuali.rice.kns.util.KualiDecimal calculateCheckTotal()
public void prepareForSave()
FinancialSystemTransactionalDocumentBase
prepareForSave
in interface org.kuali.rice.kns.document.Document
prepareForSave
in class FinancialSystemTransactionalDocumentBase
DocumentBase.prepareForSave()
public void processAfterRetrieve()
FinancialSystemTransactionalDocumentBase
processAfterRetrieve
in interface org.kuali.rice.kns.document.Document
processAfterRetrieve
in class FinancialSystemTransactionalDocumentBase
DocumentBase.processAfterRetrieve()
public void doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent)
doRouteStatusChange
in interface org.kuali.rice.kns.document.Document
doRouteStatusChange
in class GeneralLedgerPostingDocumentBase
org.kuali.rice.kns.document.Document#doRouteStatusChange()
public void postProcessSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent event)
postProcessSave
in interface org.kuali.rice.kns.document.Document
postProcessSave
in class org.kuali.rice.kns.document.DocumentBase
DocumentBase.postProcessSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent)
public void refreshCashDetails()
protected CurrencyDetail retrieveCurrencyDetail()
protected CoinDetail retrieveCoinDetail()
protected Map getCashDetailPrimaryKey()
public List buildListOfDeletionAwareLists()
buildListOfDeletionAwareLists
in interface org.kuali.rice.kns.bo.PersistableBusinessObject
buildListOfDeletionAwareLists
in class CashReceiptFamilyBase
PersistableBusinessObjectBase.buildListOfDeletionAwareLists()
public List generateSaveEvents()
generateSaveEvents
in interface org.kuali.rice.kns.document.Document
generateSaveEvents
in class AccountingDocumentBase
protected List generateEvents(List persistedChecks, List currentChecks, String errorPathPrefix, CashReceiptFamilyBase crdoc)
persistedChecks
- currentChecks
- errorPathPrefix
- crdoc
-
protected Map buildCheckMap(List checks)
checks
-
public Check createNewCheck()
public List getDepositCashReceiptControl()
public void setDepositCashReceiptControl(List depositCashReceiptControl)
depositCashReceiptControl
- The depositCashReceiptControl to set.public void toCopy() throws org.kuali.rice.kew.exception.WorkflowException
toCopy
in interface org.kuali.rice.kns.document.Copyable
toCopy
in class AccountingDocumentBase
org.kuali.rice.kew.exception.WorkflowException
AccountingDocumentBase.toCopy()
public void initializeCampusLocationCode()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |