org.kuali.kfs.sys.document
Interface GeneralLedgerPendingEntrySource

All Known Subinterfaces:

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

All Known Implementing Classes:

AccountingDocumentBase, AccountsPayableDocumentBase, AdvanceDepositDocument, AssetGlobalGeneralLedgerPendingEntrySource, AssetPaymentDocument, AssetRetirementGeneralLedgerPendingEntrySource, AssetTransferDocument, AuxiliaryVoucherDocument, BenefitExpenseTransferDocument, BudgetAdjustmentDocument, CamsGeneralLedgerPendingEntrySourceBase, CashControlDocument, CashManagementDocument, CashReceiptDocument, CashReceiptFamilyBase, CreditCardReceiptDocument, CustomerCreditMemoDocument, CustomerInvoiceDocument, CustomerInvoiceWriteoffDocument, DisbursementVoucherDocument, DistributionOfIncomeAndExpenseDocument, GeneralErrorCorrectionDocument, 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 GeneralLedgerPendingEntrySource

A collection of methods needed by anything - document or otherwise - that plans to generate General Ledger pending entries.

Method Summary

void	addPendingEntry(GeneralLedgerPendingEntry entry) Adds an UNSAVED general ledger pending entry to the GeneralLedgerPendingEntrySource, which the GLPESource can do with as it pleases
void	clearAnyGeneralLedgerPendingEntries() Requests that the posting helper removes any general ledger pending entries it might be holding, so that new ones can be generated
boolean	generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper) Creates any GeneralLedgerPostingEntry's that are based on a document, not those based on GeneralLedgerPendingEntrySourceDetail entries
boolean	generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail, GeneralLedgerPendingEntrySequenceHelper sequenceHelper) Generates any number of general ledger pending entries from a given general ledger pending entry source detail and adds them to this general ledger pending entry source
FinancialSystemDocumentHeader	getDocumentHeader() Returns a document header associated with this general ledger posting helper
String	getFinancialDocumentTypeCode() This method returns the financial document type code.
org.kuali.rice.kns.util.KualiDecimal	getGeneralLedgerPendingEntryAmountForDetail(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail) A method to determine what the actual amount, based off of a GeneralLedgerPendingEntrySourceDetail, should be for the resultant GeneralLedgerPendingEntry
List<GeneralLedgerPendingEntrySourceDetail>	getGeneralLedgerPendingEntrySourceDetails() Returns a list of any GeneralLedgerPostables this helper has, to create GeneralLedgerPendingEntries
Integer	getPostingYear()
boolean	isDebit(GeneralLedgerPendingEntrySourceDetail postable) This method determines if the passed in GeneralLedgerPendingEntrySourceDetail is a debit or not.

Method Detail

generateDocumentGeneralLedgerPendingEntries

boolean generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

Creates any GeneralLedgerPostingEntry's that are based on a document, not those based on GeneralLedgerPendingEntrySourceDetail entries

Parameters:

sequenceHelper - a sequence helper for the method to create more general ledger pending entries

Returns:

true if the pending entries were able to be successfully created and added to this GeneralLedgerPendingEntrySource; false if an error condition occurred with mean that GLPEs were not correctly generated

getPostingYear

Integer getPostingYear()

Returns:

the fiscal year when this "helper" was posted

isDebit

boolean isDebit(GeneralLedgerPendingEntrySourceDetail postable)

This method determines if the passed in GeneralLedgerPendingEntrySourceDetail is a debit or not.

Parameters:

postable -

Returns:

true if the given GeneralLedgerPendingEntrySourceDetail is a debit, false if it is a credit

getDocumentHeader

FinancialSystemDocumentHeader getDocumentHeader()

Returns a document header associated with this general ledger posting helper

Returns:

a document header, having information which should be put into the generated GeneralLedgerPendingEntry records

clearAnyGeneralLedgerPendingEntries

void clearAnyGeneralLedgerPendingEntries()

Requests that the posting helper removes any general ledger pending entries it might be holding, so that new ones can be generated

getGeneralLedgerPendingEntrySourceDetails

List<GeneralLedgerPendingEntrySourceDetail> getGeneralLedgerPendingEntrySourceDetails()

Returns a list of any GeneralLedgerPostables this helper has, to create GeneralLedgerPendingEntries

Returns:

a list of GeneralLedgerPostables

addPendingEntry

void addPendingEntry(GeneralLedgerPendingEntry entry)

Adds an UNSAVED general ledger pending entry to the GeneralLedgerPendingEntrySource, which the GLPESource can do with as it pleases

Parameters:

entry - the completed entry to give back to the helper to handle

getGeneralLedgerPendingEntryAmountForDetail

org.kuali.rice.kns.util.KualiDecimal getGeneralLedgerPendingEntryAmountForDetail(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail)

A method to determine what the actual amount, based off of a GeneralLedgerPendingEntrySourceDetail, should be for the resultant GeneralLedgerPendingEntry

Parameters:

glpeSourceDetail - the detail line from the general ledger pending entry source to find an amount for

Returns:

The amount that will be used to populate the amount on the generated general ledger pending entry for the given source detail

getFinancialDocumentTypeCode

String getFinancialDocumentTypeCode()

This method returns the financial document type code. It's required to return the appropriate financial document type code only if poster class is not assignable from org.kuali.rice.kns.document.

Returns:

the document type code

generateGeneralLedgerPendingEntries

boolean generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
                                            GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

Generates any number of general ledger pending entries from a given general ledger pending entry source detail and adds them to this general ledger pending entry source

Parameters:

glpeSourceDetail - the source detail line to generate general ledger pending entries for

sequenceHelper - the sequence helper which will assign sequence number to generated general ledger pending entries

Returns:

true if general ledger pending entry generation was successful; false if an error condition prevented the successful generation of the pending entries