org.kuali.kfs.fp.document
Class CashReceiptFamilyBase

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.sys.document.AccountingDocumentBase
                                  org.kuali.kfs.fp.document.CashReceiptFamilyBase

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, CapitalAssetEditable, AccountingDocument, 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

Direct Known Subclasses:

AdvanceDepositDocument, CashReceiptDocument, CreditCardReceiptDocument

public abstract class CashReceiptFamilyBase
extends AccountingDocumentBase
implements CapitalAssetEditable

Abstract class which defines behavior common to CashReceipt-like documents.

See Also:

Serialized Form

Field Summary

protected String	campusLocationCode
protected CapitalAssetInformation	capitalAssetInformation
protected Date	depositDate
protected static org.apache.log4j.Logger	LOG

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

CashReceiptFamilyBase()
Constructs a CashReceiptFamilyBase

Method Summary

List	buildListOfDeletionAwareLists()
void	customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable, GeneralLedgerPendingEntry explicitEntry) Overrides to set the entry's description to the description from the accounting line, if a value exists.
boolean	documentPerformsSufficientFundsCheck() Documents in the CashReceiptFamily do not perform Sufficient Funds checking
String	getCampusLocationCode() Gets the campusLocationCode attribute.
CapitalAssetInformation	getCapitalAssetInformation() Gets the capitalAssetInformation attribute.
protected CapitalAssetManagementModuleService	getCapitalAssetManagementModuleService()
Date	getDepositDate() Gets the depositDate attribute.
String	getSourceAccountingLinesSectionTitle() Overrides the base implementation to return an empty string.
org.kuali.rice.kns.util.KualiDecimal	getSourceTotal() Total for a Cash Receipt according to the spec should be the sum of the amounts on accounting lines belonging to object codes having the 'income' object type, less the sum of the amounts on accounting lines belonging to object codes having the 'expense' object type.
String	getTargetAccountingLinesSectionTitle() Overrides the base implementation to return an empty string.
org.kuali.rice.kns.util.KualiDecimal	getTargetTotal() Cash Receipts only have source lines, so this should always return 0.
boolean	isDebit(GeneralLedgerPendingEntrySourceDetail postable) Returns true if accounting line is debit
void	setCampusLocationCode(String campusLocationCode) Sets the campusLocationCode attribute value.
void	setCapitalAssetInformation(CapitalAssetInformation capitalAssetInformation) Sets the capitalAssetInformation attribute.
void	setDepositDate(Date depositDate) Sets the depositDate attribute value.

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

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

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

addPendingEntry, changeGeneralLedgerPendingEntriesApprovedStatusCode, checkSufficientFunds, clearAnyGeneralLedgerPendingEntries, doRouteStatusChange, 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, prepareForSave, processAfterRetrieve, 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, postProcessSave, 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.sys.document.GeneralLedgerPostingDocument

checkSufficientFunds, 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, doRouteStatusChange, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, processAfterRetrieve, 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

campusLocationCode

protected String campusLocationCode

depositDate

protected Date depositDate

capitalAssetInformation

protected transient CapitalAssetInformation capitalAssetInformation

Constructor Detail

CashReceiptFamilyBase

public CashReceiptFamilyBase()

Constructs a CashReceiptFamilyBase

Method Detail

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Specified by:

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

Overrides:

buildListOfDeletionAwareLists in class AccountingDocumentBase

See Also:

AccountingDocumentBase.buildListOfDeletionAwareLists()

documentPerformsSufficientFundsCheck

public boolean documentPerformsSufficientFundsCheck()

Documents in the CashReceiptFamily do not perform Sufficient Funds checking

Overrides:

documentPerformsSufficientFundsCheck in class GeneralLedgerPostingDocumentBase

Returns:

See Also:

GeneralLedgerPostingDocumentBase.documentPerformsSufficientFundsCheck()

getCampusLocationCode

public String getCampusLocationCode()

Gets the campusLocationCode attribute.

Returns:

Returns the campusLocationCode.

setCampusLocationCode

public void setCampusLocationCode(String campusLocationCode)

Sets the campusLocationCode attribute value.

Parameters:

campusLocationCode - The campusLocationCode to set.

getDepositDate

public Date getDepositDate()

Gets the depositDate attribute.

Returns:

Returns the depositDate.

setDepositDate

public void setDepositDate(Date depositDate)

Sets the depositDate attribute value.

Parameters:

depositDate - The depositDate to set.

getSourceTotal

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

Total for a Cash Receipt according to the spec should be the sum of the amounts on accounting lines belonging to object codes having the 'income' object type, less the sum of the amounts on accounting lines belonging to object codes having the 'expense' object type.

Specified by:

getSourceTotal in interface AccountingDocument

Overrides:

getSourceTotal in class AccountingDocumentBase

See Also:

AccountingDocument.getSourceTotal()

getTargetTotal

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

Cash Receipts only have source lines, so this should always return 0.

Specified by:

getTargetTotal in interface AccountingDocument

Overrides:

getTargetTotal in class AccountingDocumentBase

See Also:

AccountingDocument.getTargetTotal()

getSourceAccountingLinesSectionTitle

public String getSourceAccountingLinesSectionTitle()

Overrides the base implementation to return an empty string.

Specified by:

getSourceAccountingLinesSectionTitle in interface AccountingDocument

Overrides:

getSourceAccountingLinesSectionTitle in class AccountingDocumentBase

Returns:

The source accounting line section's title.

See Also:

AccountingDocument.getSourceAccountingLinesSectionTitle()

getTargetAccountingLinesSectionTitle

public String getTargetAccountingLinesSectionTitle()

Overrides the base implementation to return an empty string.

Specified by:

getTargetAccountingLinesSectionTitle in interface AccountingDocument

Overrides:

getTargetAccountingLinesSectionTitle in class AccountingDocumentBase

Returns:

The target accounting line section's title.

See Also:

AccountingDocument.getTargetAccountingLinesSectionTitle()

isDebit

public boolean isDebit(GeneralLedgerPendingEntrySourceDetail postable)

Returns true if accounting line is debit

Specified by:

isDebit in interface GeneralLedgerPendingEntrySource

Specified by:

isDebit in class AccountingDocumentBase

Parameters:

financialDocument -

accountingLine -

true - if accountline line

Returns:

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

See Also:

IsDebitUtils#isDebitConsideringType(FinancialDocumentRuleBase, FinancialDocument, AccountingLine), org.kuali.rice.kns.rule.AccountingLineRule#isDebit(org.kuali.rice.kns.document.FinancialDocument, org.kuali.rice.kns.bo.AccountingLine)

customizeExplicitGeneralLedgerPendingEntry

public void customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable,
                                                       GeneralLedgerPendingEntry explicitEntry)

Overrides to set the entry's description to the description from the accounting line, if a value exists.

Overrides:

customizeExplicitGeneralLedgerPendingEntry in class AccountingDocumentBase

Parameters:

financialDocument - submitted accounting document

accountingLine - accounting line in accounting document

explicitEntry - general ledger pending entry

See Also:

org.kuali.module.financial.rules.FinancialDocumentRuleBase#customizeExplicitGeneralLedgerPendingEntry(org.kuali.rice.kns.document.FinancialDocument, org.kuali.rice.kns.bo.AccountingLine, org.kuali.module.gl.bo.GeneralLedgerPendingEntry)

getCapitalAssetInformation

public CapitalAssetInformation getCapitalAssetInformation()

Description copied from interface: CapitalAssetEditable

Gets the capitalAssetInformation attribute.

Specified by:

getCapitalAssetInformation in interface CapitalAssetEditable

Returns:

Returns the capitalAssetInformation.

See Also:

CapitalAssetEditable.getCapitalAssetInformation()

setCapitalAssetInformation

public void setCapitalAssetInformation(CapitalAssetInformation capitalAssetInformation)

Description copied from interface: CapitalAssetEditable

Sets the capitalAssetInformation attribute.

Specified by:

setCapitalAssetInformation in interface CapitalAssetEditable

See Also:

CapitalAssetEditable.setCapitalAssetInformation(org.kuali.kfs.fp.businessobject.CapitalAssetInformation)

getCapitalAssetManagementModuleService

protected CapitalAssetManagementModuleService getCapitalAssetManagementModuleService()