org.kuali.ole.fp.document

Class CashReceiptFamilyBase

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

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, CapitalAssetEditable, AccountingDocument, 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.Document, org.kuali.rice.krad.document.SessionDocument, org.kuali.rice.krad.document.TransactionalDocument

Direct Known Subclasses:

AdvanceDepositDocument, CashReceiptDocument, CreditCardReceiptDocument

public abstract class CashReceiptFamilyBase
extends CapitalAccountingLinesDocumentBase
implements CapitalAssetEditable

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	campusLocationCode
protected Date	depositDate
protected static org.apache.log4j.Logger	LOG

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
CashReceiptFamilyBase() Constructs a CashReceiptFamilyBase

Method Summary

Methods

Modifier and Type	Method and Description
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.
List<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.core.api.util.type.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.core.api.util.type.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(List<CapitalAssetInformation> capitalAssetInformation) Sets the capitalAssetInformation attribute.
void	setDepositDate(Date depositDate) Sets the depositDate attribute value.

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

getCapitalAccountingLines, setCapitalAccountingLines

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

buildListOfDeletionAwareLists, doRouteStatusChange, getNextCapitalAssetLineNumber, setNextCapitalAssetLineNumber

Methods inherited from class org.kuali.ole.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, isDocumentFinalOrProcessed, prepareForSave, processExplicitGeneralLedgerPendingEntry, processOffsetGeneralLedgerPendingEntry, setNextSourceLineNumber, setNextTargetLineNumber, setSourceAccountingLines, setTargetAccountingLines, toCopy, toErrorCorrection, updatePostingYearForAccountingLines

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

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

checkSufficientFunds, 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, postProcessSave, prepareForSave, processAfterRetrieve, 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

LOG

protected static org.apache.log4j.Logger LOG

campusLocationCode

protected String campusLocationCode

depositDate

protected Date depositDate

Constructor Detail

CashReceiptFamilyBase

public CashReceiptFamilyBase()

Constructs a CashReceiptFamilyBase

Method Detail

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.core.api.util.type.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.core.api.util.type.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

Overrides:

isDebit in class CapitalAssetInformationDocumentBase

Parameters:

financialDocument -

accountingLine -

true - if accountline line

Returns:

true is account line is debit

See Also:

IsDebitUtils#isDebitConsideringType(FinancialDocumentRuleBase, FinancialDocument, AccountingLine), org.kuali.rice.krad.rule.AccountingLineRule#isDebit(org.kuali.rice.krad.document.FinancialDocument, org.kuali.rice.krad.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.krad.document.FinancialDocument, org.kuali.rice.krad.bo.AccountingLine, org.kuali.module.gl.bo.GeneralLedgerPendingEntry)

getCapitalAssetInformation

public List<CapitalAssetInformation> getCapitalAssetInformation()

Description copied from interface: CapitalAssetEditable

Gets the capitalAssetInformation attribute.

Specified by:

getCapitalAssetInformation in interface CapitalAssetEditable

Overrides:

getCapitalAssetInformation in class CapitalAssetInformationDocumentBase

Returns:

Returns the capitalAssetInformation.

See Also:

CapitalAssetEditable.getCapitalAssetInformation()

setCapitalAssetInformation

public void setCapitalAssetInformation(List<CapitalAssetInformation> capitalAssetInformation)

Description copied from interface: CapitalAssetEditable

Sets the capitalAssetInformation attribute.

Specified by:

setCapitalAssetInformation in interface CapitalAssetEditable

Overrides:

setCapitalAssetInformation in class CapitalAssetInformationDocumentBase

See Also:

org.kuali.ole.fp.document.CapitalAssetEditable#setCapitalAssetInformation(org.kuali.ole.fp.businessobject.CapitalAssetInformation)

getCapitalAssetManagementModuleService

protected CapitalAssetManagementModuleService getCapitalAssetManagementModuleService()