org.kuali.kfs.fp.document

Class AdvanceDepositDocument

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.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.CapitalAssetInformationDocumentBase

org.kuali.kfs.fp.document.CapitalAccountingLinesDocumentBase

org.kuali.kfs.fp.document.CashReceiptFamilyBase

org.kuali.kfs.fp.document.AdvanceDepositDocument

All Implemented Interfaces:

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

public class AdvanceDepositDocument
extends CashReceiptFamilyBase
implements org.kuali.rice.krad.document.Copyable, AmountTotaling, Correctable

This is the business object that represents the AdvanceDeposit document in Kuali. This is a transactional document that will eventually post transactions to the G/L. It integrates with workflow. Since an Advance Deposit document 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

Fields

Modifier and Type	Field and Description
static String	ADVANCE_DEPOSIT_DOCUMENT_TYPE_CODE
protected List<AdvanceDepositDetail>	advanceDeposits
protected Integer	nextAdvanceDepositLineNumber
protected org.kuali.rice.core.api.util.type.KualiDecimal	totalAdvanceDepositAmount

Fields inherited from class org.kuali.kfs.fp.document.CashReceiptFamilyBase

campusLocationCode, depositDate, LOG

Fields inherited from class org.kuali.kfs.fp.document.CapitalAccountingLinesDocumentBase

capitalAccountingLines, capitalAccountingLinesExist

Fields inherited from class org.kuali.kfs.fp.document.CapitalAssetInformationDocumentBase

capitalAssetInformation, nextCapitalAssetLineNumber

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

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
AdvanceDepositDocument() Default constructor that calls super.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAdvanceDeposit(AdvanceDepositDetail advanceDepositDetail) Adds a new advance deposit to the list.
List	buildListOfDeletionAwareLists() Overrides super to call super and then also add in the new list of advance deposits that have to be managed.
protected void	correctAdvanceDepositDetails() Upon error correction, negates amount in each advance deposit detail, and updates the documentNumber to point to the new document.
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent) This method defers to its parent's version of handleRouteStatusChange, but then, if the document is processed, it creates ElectronicPaymentClaim records for any qualifying accountings lines in the document.
boolean	generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper) Generates bank offset GLPEs for deposits, if enabled.
AdvanceDepositDetail	getAdvanceDepositDetail(int index) Retrieve a particular advance deposit at a given index in the list of advance deposits.
List<AdvanceDepositDetail>	getAdvanceDeposits() Gets the list of advance deposits which is a list of AdvanceDepositDetail business objects.
String	getCurrencyFormattedTotalAdvanceDepositAmount() This method returns the advance deposit total amount as a currency formatted string.
Integer	getNextAdvanceDepositLineNumber()
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalAdvanceDepositAmount() Gets the total advance deposit amount.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalDollarAmount() This method returns the overall total of the document - the advance deposit total.
void	postProcessSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)
void	prepareNewAdvanceDeposit(AdvanceDepositDetail advanceDepositDetail) This is a helper method that automatically populates document specfic information into the advance deposit (AdvanceDepositDetail) instance.
void	removeAdvanceDeposit(int index) This method removes an advance deposit from the list and updates the total appropriately.
void	setAdvanceDeposits(List<AdvanceDepositDetail> advanceDeposits) Sets the advance deposits list.
void	setNextAdvanceDepositLineNumber(Integer nextAdvanceDepositLineNumber)
void	setTotalAdvanceDepositAmount(org.kuali.rice.core.api.util.type.KualiDecimal advanceDepositAmount) Sets the total advance deposit amount which is the sum of all advance deposits on this document.
void	toErrorCorrection() Converts this Document instance into an error correction of itself.

Methods inherited from class org.kuali.kfs.fp.document.CashReceiptFamilyBase

correctCapitalAccountingLines, customizeExplicitGeneralLedgerPendingEntry, documentPerformsSufficientFundsCheck, getCampusLocationCode, getCapitalAssetInformation, getCapitalAssetManagementModuleService, getDepositDate, getSourceAccountingLinesSectionTitle, getSourceTotal, getTargetAccountingLinesSectionTitle, getTargetTotal, isDebit, isErrorCorrected, setCampusLocationCode, setCapitalAssetInformation, setDepositDate

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

getCapitalAccountingLines, isCapitalAccountingLinesExist, setCapitalAccountingLines, setCapitalAccountingLinesExist

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

getNextCapitalAssetLineNumber, setNextCapitalAssetLineNumber

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

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

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

addPendingEntry, changeGeneralLedgerPendingEntriesApprovedStatusCode, checkSufficientFunds, clearAnyGeneralLedgerPendingEntries, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, removeGeneralLedgerPendingEntries, setGeneralLedgerPendingEntries

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

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

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

answerSplitNodeQuestion, captureWorkflowHeaderInformation, doRouteLevelChange, getApplicationDocumentStatus, getBusinessObjectService, getFinancialSystemDocumentHeader, getFinancialSystemDocumentService, getParameterService, getWorkflowDocumentStatusCode, 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, 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.rice.krad.document.Copyable

toCopy

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

getApplicationDocumentStatus, setApplicationDocumentStatus, updateAndSaveAppDocStatus

Methods inherited from interface org.kuali.kfs.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, 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.kfs.sys.document.GeneralLedgerPendingEntrySource

addPendingEntry, clearAnyGeneralLedgerPendingEntries, getDocumentHeader, getFinancialDocumentTypeCode, getFinancialSystemDocumentHeader, getPostingYear

Field Detail

ADVANCE_DEPOSIT_DOCUMENT_TYPE_CODE

public static final String ADVANCE_DEPOSIT_DOCUMENT_TYPE_CODE

See Also:

Constant Field Values

advanceDeposits

protected List<AdvanceDepositDetail> advanceDeposits

nextAdvanceDepositLineNumber

protected Integer nextAdvanceDepositLineNumber

totalAdvanceDepositAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal totalAdvanceDepositAmount

Constructor Detail

AdvanceDepositDocument

public AdvanceDepositDocument()

Default constructor that calls super.

Method Detail

getTotalAdvanceDepositAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalAdvanceDepositAmount()

Gets the total advance deposit amount.

Returns:

KualiDecimal

getCurrencyFormattedTotalAdvanceDepositAmount

public String getCurrencyFormattedTotalAdvanceDepositAmount()

This method returns the advance deposit total amount as a currency formatted string.

Returns:

String

setTotalAdvanceDepositAmount

public void setTotalAdvanceDepositAmount(org.kuali.rice.core.api.util.type.KualiDecimal advanceDepositAmount)

Sets the total advance deposit amount which is the sum of all advance deposits on this document.

Parameters:

advanceDepositAmount -

getAdvanceDeposits

public List<AdvanceDepositDetail> getAdvanceDeposits()

Gets the list of advance deposits which is a list of AdvanceDepositDetail business objects.

Returns:

List

setAdvanceDeposits

public void setAdvanceDeposits(List<AdvanceDepositDetail> advanceDeposits)

Sets the advance deposits list.

Parameters:

advanceDeposits -

addAdvanceDeposit

public void addAdvanceDeposit(AdvanceDepositDetail advanceDepositDetail)

Adds a new advance deposit to the list.

Parameters:

advanceDepositDetail -

prepareNewAdvanceDeposit

public final void prepareNewAdvanceDeposit(AdvanceDepositDetail advanceDepositDetail)

This is a helper method that automatically populates document specfic information into the advance deposit (AdvanceDepositDetail) instance.

Parameters:

advanceDepositDetail -

getAdvanceDepositDetail

public AdvanceDepositDetail getAdvanceDepositDetail(int index)

Retrieve a particular advance deposit at a given index in the list of advance deposits.

Parameters:

index -

Returns:

AdvanceDepositDetail

removeAdvanceDeposit

public void removeAdvanceDeposit(int index)

This method removes an advance deposit from the list and updates the total appropriately.

Parameters:

index -

getNextAdvanceDepositLineNumber

public Integer getNextAdvanceDepositLineNumber()

Returns:

Integer

setNextAdvanceDepositLineNumber

public void setNextAdvanceDepositLineNumber(Integer nextAdvanceDepositLineNumber)

Parameters:

nextAdvanceDepositLineNumber -

getTotalDollarAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalDollarAmount()

This method returns the overall total of the document - the advance deposit total.

Specified by:

getTotalDollarAmount in interface AmountTotaling

Overrides:

getTotalDollarAmount in class AccountingDocumentBase

Returns:

KualiDecimal

See Also:

AccountingDocumentBase.getTotalDollarAmount()

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)

This method defers to its parent's version of handleRouteStatusChange, but then, if the document is processed, it creates ElectronicPaymentClaim records for any qualifying accountings lines in the document.

Specified by:

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

Overrides:

doRouteStatusChange in class CapitalAssetInformationDocumentBase

See Also:

org.kuali.kfs.sys.document.GeneralLedgerPostingDocumentBase#doRouteStatusChange()

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Overrides super to call super and then also add in the new list of advance deposits that have to be managed.

Specified by:

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

Overrides:

buildListOfDeletionAwareLists in class CapitalAssetInformationDocumentBase

See Also:

PersistableBusinessObjectBase.buildListOfDeletionAwareLists()

generateDocumentGeneralLedgerPendingEntries

public boolean generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

Generates bank offset GLPEs for deposits, if enabled.

Specified by:

generateDocumentGeneralLedgerPendingEntries in interface GeneralLedgerPendingEntrySource

Overrides:

generateDocumentGeneralLedgerPendingEntries in class AccountingDocumentBase

Parameters:

financialDocument - submitted financial document

sequenceHelper - helper class which will allows us to increment a reference without using an Integer

Returns:

true if there are no issues creating GLPE's

See Also:

org.kuali.rice.krad.rule.GenerateGeneralLedgerDocumentPendingEntriesRule#processGenerateDocumentGeneralLedgerPendingEntries(org.kuali.rice.krad.document.FinancialDocument,org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySequenceHelper)

postProcessSave

public void postProcessSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)

Specified by:

postProcessSave in interface org.kuali.rice.krad.document.Document

Overrides:

postProcessSave in class org.kuali.rice.krad.document.DocumentBase

toErrorCorrection

public void toErrorCorrection()
                       throws org.kuali.rice.kew.api.exception.WorkflowException

Description copied from interface: Correctable

Converts this Document instance into an error correction of itself.

Specified by:

toErrorCorrection in interface Correctable

Overrides:

toErrorCorrection in class AccountingDocumentBase

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

AccountingDocumentBase.toErrorCorrection()

correctAdvanceDepositDetails

protected void correctAdvanceDepositDetails()

Upon error correction, negates amount in each advance deposit detail, and updates the documentNumber to point to the new document.