org.kuali.ole.sys.document

Interface AccountingDocument

All Superinterfaces:

org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.document.Document, FinancialSystemDocument, FinancialSystemTransactionalDocument, GeneralLedgerPendingEntrySource, GeneralLedgerPostingDocument, org.kuali.rice.core.api.mo.common.GloballyUnique, LedgerPostingDocument, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.PersistableBusinessObject, Serializable, org.kuali.rice.krad.document.TransactionalDocument, org.kuali.rice.core.api.mo.common.Versioned

All Known Subinterfaces:

AccountsPayableDocument, PurchasingAccountsPayableDocument, PurchasingDocument, VoucherDocument

All Known Implementing Classes:

AccountingDocumentBase, AccountsPayableDocumentBase, AdvanceDepositDocument, AuxiliaryVoucherDocument, BudgetAdjustmentDocument, CapitalAccountingLinesDocumentBase, CapitalAssetInformationDocumentBase, CashReceiptDocument, CashReceiptFamilyBase, CreditCardReceiptDocument, DisbursementVoucherDocument, DistributionOfIncomeAndExpenseDocument, GeneralErrorCorrectionDocument, IndirectCostAdjustmentDocument, InternalBillingDocument, InvoiceDocument, JournalVoucherDocument, NonCheckDisbursementDocument, OleDisbursementVoucherDocument, OleDistributionOfIncomeAndExpenseDocument, OleGeneralErrorCorrectionDocument, OleInvoiceDocument, OlePaymentRequestDocument, OlePurchaseOrderAmendmentDocument, OlePurchaseOrderCloseDocument, OlePurchaseOrderDocument, OlePurchaseOrderPaymentHoldDocument, OlePurchaseOrderRemoveHoldDocument, OlePurchaseOrderReopenDocument, OlePurchaseOrderRetransmitDocument, OlePurchaseOrderSplitDocument, OlePurchaseOrderVoidDocument, OleRequisitionDocument, OleVendorCreditMemoDocument, PaymentRequestDocument, PreEncumbranceDocument, ProcurementCardDocument, PurchaseOrderAmendmentDocument, PurchaseOrderCloseDocument, PurchaseOrderDocument, PurchaseOrderPaymentHoldDocument, PurchaseOrderRemoveHoldDocument, PurchaseOrderReopenDocument, PurchaseOrderRetransmitDocument, PurchaseOrderSplitDocument, PurchaseOrderVoidDocument, PurchasingAccountsPayableDocumentBase, PurchasingDocumentBase, RequisitionDocument, ServiceBillingDocument, TransferOfFundsDocument, VendorCreditMemoDocument, YearEndBudgetAdjustmentDocument, YearEndDistributionOfIncomeAndExpenseDocument, YearEndGeneralErrorCorrectionDocument, YearEndTransferOfFundsDocument

public interface AccountingDocument
extends GeneralLedgerPostingDocument, GeneralLedgerPendingEntrySource

This is the FinancialDocument interface. The TransactionalDocument interface should extend this. It represents any document that exists within the Financial Transactions module, but isn't transactional (i.e. no accounting lines). This interface was put in place to facilitate the CashManagementDocument which is a Financial Transaction module document, but doesn't have accounting lines.

Method Summary

Methods

Modifier and Type	Method and Description
void	addSourceAccountingLine(SourceAccountingLine line) This method adds a source accounting line.
void	addTargetAccountingLine(TargetAccountingLine line) This method adds a target accounting line to the document.
AccountingLineParser	getAccountingLineParser()
Class<? extends AccountingDocument>	getDocumentClassForAccountingLineValueAllowedValidation() This method returns the Class to use for AccountingLingValuesAllowedValidation.
Integer	getNextSourceLineNumber() Retrieves the next line sequence number for an accounting line in the Source accounting line section on a transactional document.
Integer	getNextTargetLineNumber() Retrieves the next line sequence number for an accounting line in the Target accounting line section on a transactional document.
SourceAccountingLine	getSourceAccountingLine(int index) This method returns the accounting line at a particular spot in the overall list of accounting lines.
Class	getSourceAccountingLineClass()
String	getSourceAccountingLineEntryName()
List	getSourceAccountingLines() This method returns a list of target accounting lines.
String	getSourceAccountingLinesSectionTitle() This method is used to return the title that a transactional document should give to it's source accounting line section.
org.kuali.rice.core.api.util.type.KualiDecimal	getSourceTotal() Sums up the amounts of all of the source accounting lines.
TargetAccountingLine	getTargetAccountingLine(int index) This method retrieves the target accounting line at the specified index.
Class	getTargetAccountingLineClass()
String	getTargetAccountingLineEntryName()
List	getTargetAccountingLines() This method retrieves all of the target accounting lines associated with this document.
String	getTargetAccountingLinesSectionTitle() This method is used to return the title that a transactional document should give to it's source accounting line section.
org.kuali.rice.core.api.util.type.KualiDecimal	getTargetTotal() Sums up the amounts of all of the target accounting lines.
boolean	isDocumentFinalOrProcessed() This method check the document status to determine whether the document is final/processed or not.
void	setNextSourceLineNumber(Integer nextLineNumber)
void	setNextTargetLineNumber(Integer nextLineNumber)
void	setSourceAccountingLines(List sourceLines) This method sets the list of source accounting lines for this document.
void	setTargetAccountingLines(List targetLines) This method sets the list of target accounting lines for this document.

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, doRouteStatusChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNotes, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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

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

Method Detail

getSourceAccountingLinesSectionTitle

String getSourceAccountingLinesSectionTitle()

This method is used to return the title that a transactional document should give to it's source accounting line section.

Returns:

The source accounting line section's title.

getTargetAccountingLinesSectionTitle

String getTargetAccountingLinesSectionTitle()

This method is used to return the title that a transactional document should give to it's source accounting line section.

Returns:

The target accounting line section's title.

getTargetTotal

org.kuali.rice.core.api.util.type.KualiDecimal getTargetTotal()

Sums up the amounts of all of the target accounting lines.

getSourceTotal

org.kuali.rice.core.api.util.type.KualiDecimal getSourceTotal()

Sums up the amounts of all of the source accounting lines.

getAccountingLineParser

AccountingLineParser getAccountingLineParser()

Returns:

AccountingLineParser instance appropriate for importing AccountingLines for this document type

getSourceAccountingLineClass

Class getSourceAccountingLineClass()

getTargetAccountingLineClass

Class getTargetAccountingLineClass()

getSourceAccountingLineEntryName

String getSourceAccountingLineEntryName()

getTargetAccountingLineEntryName

String getTargetAccountingLineEntryName()

getNextSourceLineNumber

Integer getNextSourceLineNumber()

Retrieves the next line sequence number for an accounting line in the Source accounting line section on a transactional document.

Returns:

The next available source line number.

setNextSourceLineNumber

void setNextSourceLineNumber(Integer nextLineNumber)

Parameters:

nextLineNumber -

getNextTargetLineNumber

Integer getNextTargetLineNumber()

Retrieves the next line sequence number for an accounting line in the Target accounting line section on a transactional document.

Returns:

The next available target line number.

setNextTargetLineNumber

void setNextTargetLineNumber(Integer nextLineNumber)

Parameters:

nextLineNumber -

addSourceAccountingLine

void addSourceAccountingLine(SourceAccountingLine line)

This method adds a source accounting line.

Parameters:

line -

getSourceAccountingLines

List getSourceAccountingLines()

This method returns a list of target accounting lines.

Returns:

The list of source accounting lines.

getSourceAccountingLine

SourceAccountingLine getSourceAccountingLine(int index)

This method returns the accounting line at a particular spot in the overall list of accounting lines.

Parameters:

index -

Returns:

The source accounting line at the specified index.

setSourceAccountingLines

void setSourceAccountingLines(List sourceLines)

This method sets the list of source accounting lines for this document.

Parameters:

sourceLines -

addTargetAccountingLine

void addTargetAccountingLine(TargetAccountingLine line)

This method adds a target accounting line to the document.

Parameters:

line -

getTargetAccountingLines

List getTargetAccountingLines()

This method retrieves all of the target accounting lines associated with this document.

getTargetAccountingLine

TargetAccountingLine getTargetAccountingLine(int index)

This method retrieves the target accounting line at the specified index.

Parameters:

index -

Returns:

The target accounting line at the passed in index.

setTargetAccountingLines

void setTargetAccountingLines(List targetLines)

This method sets the list of target accounting lines for this document.

Parameters:

targetLines -

getDocumentClassForAccountingLineValueAllowedValidation

Class<? extends AccountingDocument> getDocumentClassForAccountingLineValueAllowedValidation()

This method returns the Class to use for AccountingLingValuesAllowedValidation.

isDocumentFinalOrProcessed

boolean isDocumentFinalOrProcessed()

This method check the document status to determine whether the document is final/processed or not.

Returns:

true if documentFinalOrProcessed otherwise false