org.kuali.kfs.sys.document
Interface GeneralLedgerPostingDocument

All Superinterfaces:

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

All Known Subinterfaces:

AccountingDocument, AccountsPayableDocument, LaborExpenseTransferDocument, LaborLedgerPostingDocument, PurchasingAccountsPayableDocument, PurchasingDocument, VoucherDocument

All Known Implementing Classes:

AccountingDocumentBase, AccountsPayableDocumentBase, AdvanceDepositDocument, AssetDepreciationDocument, AssetPaymentDocument, AssetTransferDocument, AuxiliaryVoucherDocument, BenefitExpenseTransferDocument, BudgetAdjustmentDocument, CashControlDocument, CashManagementDocument, CashReceiptDocument, CashReceiptFamilyBase, CreditCardReceiptDocument, CustomerCreditMemoDocument, CustomerInvoiceDocument, CustomerInvoiceWriteoffDocument, DisbursementVoucherDocument, DistributionOfIncomeAndExpenseDocument, GeneralErrorCorrectionDocument, GeneralLedgerPostingDocumentBase, IndirectCostAdjustmentDocument, InternalBillingDocument, JournalVoucherDocument, LaborExpenseTransferDocumentBase, LaborJournalVoucherDocument, LaborLedgerPostingDocumentBase, LaborYearEndBenefitTransferDocument, NonCheckDisbursementDocument, PaymentApplicationDocument, PaymentRequestDocument, PreEncumbranceDocument, ProcurementCardDocument, PurchaseOrderAmendmentDocument, PurchaseOrderCloseDocument, PurchaseOrderDocument, PurchaseOrderPaymentHoldDocument, PurchaseOrderRemoveHoldDocument, PurchaseOrderReopenDocument, PurchaseOrderRetransmitDocument, PurchaseOrderSplitDocument, PurchaseOrderVoidDocument, PurchasingAccountsPayableDocumentBase, PurchasingDocumentBase, RequisitionDocument, SalaryExpenseTransferDocument, ServiceBillingDocument, TransferOfFundsDocument, VendorCreditMemoDocument, YearEndBenefitExpenseTransferDocument, YearEndBudgetAdjustmentDocument, YearEndDistributionOfIncomeAndExpenseDocument, YearEndGeneralErrorCorrectionDocument, YearEndSalaryExpenseTransferDocument, YearEndTransferOfFundsDocument

public interface GeneralLedgerPostingDocument
extends LedgerPostingDocument

Defines methods that must be implements for a general ledger posting document.

Method Summary

List<SufficientFundsItem>	checkSufficientFunds() This method will check sufficient funds for the document
List<GeneralLedgerPendingEntry>	getGeneralLedgerPendingEntries() This method retrieves the list of GLPEs for the document.
GeneralLedgerPendingEntry	getGeneralLedgerPendingEntry(int index) This method retrieves a particular pending entry instance, automatically instantiating any missing intervening instances.
List<GeneralLedgerPendingEntry>	getPendingLedgerEntriesForSufficientFundsChecking() This method will return only PLEs that should be checked for SF.
void	setGeneralLedgerPendingEntries(List<GeneralLedgerPendingEntry> generalLedgerPendingEntries) This method sets the list of pending entries for this document.

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

Method Detail

getGeneralLedgerPendingEntries

List<GeneralLedgerPendingEntry> getGeneralLedgerPendingEntries()

This method retrieves the list of GLPEs for the document.

Returns:

A list of pending entries.

getGeneralLedgerPendingEntry

GeneralLedgerPendingEntry getGeneralLedgerPendingEntry(int index)

This method retrieves a particular pending entry instance, automatically instantiating any missing intervening instances. This behavior is coupled tightly with some underlying issues that the Struts PojoProcessor plugin has with how objects get instantiated within lists. This behavior is required because otherwise when the PojoProcessor tries to automatically inject values into the list, it will get an index out of bounds error if the instance at an index is being called and prior instances at indices before that one are not being instantiated.

Parameters:

index -

Returns:

The GLPE instance at the passed in index.

setGeneralLedgerPendingEntries

void setGeneralLedgerPendingEntries(List<GeneralLedgerPendingEntry> generalLedgerPendingEntries)

This method sets the list of pending entries for this document.

Parameters:

generalLedgerPendingEntries -

checkSufficientFunds

List<SufficientFundsItem> checkSufficientFunds()

This method will check sufficient funds for the document

Returns:

a list of sufficientfundsitems that do not have sufficient funds. It returns an empty list if there is sufficient funds for the entire document

getPendingLedgerEntriesForSufficientFundsChecking

List<GeneralLedgerPendingEntry> getPendingLedgerEntriesForSufficientFundsChecking()

This method will return only PLEs that should be checked for SF. Normally this will be all PLEs, but some docs (such as BA) have additional requirements.

Returns:

a list of sufficientfundsitems that do not have sufficient funds. It returns an empty list if there is sufficient funds for the entire document