org.kuali.kfs.fp.document
Interface VoucherDocument

All Superinterfaces:

AccountingDocument, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.document.Document, FinancialSystemTransactionalDocument, GeneralLedgerPendingEntrySource, GeneralLedgerPostingDocument, LedgerPostingDocument, org.kuali.rice.kns.bo.PersistableBusinessObject, org.apache.ojb.broker.PersistenceBrokerAware, Serializable, org.kuali.rice.kns.document.TransactionalDocument

All Known Implementing Classes:

AuxiliaryVoucherDocument, JournalVoucherDocument, LaborJournalVoucherDocument

public interface VoucherDocument
extends AccountingDocument

Interface for voucher type documents that require debit/credit support

Method Summary

org.kuali.rice.kns.util.KualiDecimal	getCreditTotal() This method calculates the credit total for a voucher document keying off of the debit/credit code, only summing the accounting lines with a debitCreditCode that matched the debit constant, and returns the results.
org.kuali.rice.kns.util.KualiDecimal	getDebitTotal() This method calculates the debit total for a voucher document keying off of the debit/debit code, only summing the accounting lines with a debitDebitCode that matched the debit constant, and returns the results.
Date	getReversalDate() This method retrieves the reversal date associated with this document.
void	setReversalDate(Date reversalDate) This method sets the reversal date associated with this document.

Methods inherited from interface org.kuali.kfs.sys.document.AccountingDocument

addSourceAccountingLine, addTargetAccountingLine, getAccountingLineParser, getDocumentClassForAccountingLineValueAllowedValidation, getNextSourceLineNumber, getNextTargetLineNumber, getSourceAccountingLine, getSourceAccountingLineClass, getSourceAccountingLineEntryName, getSourceAccountingLines, getSourceAccountingLinesSectionTitle, getSourceTotal, getTargetAccountingLine, getTargetAccountingLineClass, getTargetAccountingLineEntryName, getTargetAccountingLines, getTargetAccountingLinesSectionTitle, getTargetTotal, setNextSourceLineNumber, setNextTargetLineNumber, setSourceAccountingLines, setTargetAccountingLines

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, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from interface org.kuali.rice.kns.bo.PersistableBusinessObject

addNote, buildListOfDeletionAwareLists, 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, generateDocumentGeneralLedgerPendingEntries, generateGeneralLedgerPendingEntries, getDocumentHeader, getFinancialDocumentTypeCode, getGeneralLedgerPendingEntryAmountForDetail, getGeneralLedgerPendingEntrySourceDetails, getPostingYear, isDebit

Method Detail

getReversalDate

Date getReversalDate()

This method retrieves the reversal date associated with this document.

Returns:

java.sql.Date

setReversalDate

void setReversalDate(Date reversalDate)

This method sets the reversal date associated with this document.

Parameters:

reversalDate -

getDebitTotal

org.kuali.rice.kns.util.KualiDecimal getDebitTotal()

This method calculates the debit total for a voucher document keying off of the debit/debit code, only summing the accounting lines with a debitDebitCode that matched the debit constant, and returns the results.

Returns:

KualiDecimal

getCreditTotal

org.kuali.rice.kns.util.KualiDecimal getCreditTotal()

This method calculates the credit total for a voucher document keying off of the debit/credit code, only summing the accounting lines with a debitCreditCode that matched the debit constant, and returns the results.

Returns:

KualiDecimal