org.kuali.kfs.sys.service
Interface GeneralLedgerPendingEntryService

All Known Implementing Classes:

GeneralLedgerPendingEntryServiceImpl

public interface GeneralLedgerPendingEntryService

This interface defines methods that a GeneralLedgerPendingEntry Service must provide

Method Summary

GeneralLedgerPendingEntry	buildGeneralLedgerPendingEntry(GeneralLedgerPostingDocument document, Account account, ObjectCode objectCode, String subAccountNumber, String subObjectCode, String organizationReferenceId, String projectCode, String referenceNumber, String referenceTypeCode, String referenceOriginCode, String description, boolean isDebit, org.kuali.rice.kns.util.KualiDecimal amount, GeneralLedgerPendingEntrySequenceHelper sequenceHelper) Convenience method to build a GLPE without a generalLedgerPendingEntrySourceDetail
void	delete(String documentHeaderId)
void	deleteByFinancialDocumentApprovedCode(String financialDocumentApprovedCode) Delete all pending entries for a specific document approved code
void	fillInFiscalPeriodYear(GeneralLedgerPendingEntry glpe) The fiscal year and period is null in quite a few glpe's.
Iterator	findApprovedPendingLedgerEntries() The method finds all pending ledger entries
Collection	findPendingEntries(Map fieldValues, boolean isApproved)
Iterator	findPendingLedgerEntries(Balance balance, boolean isApproved, boolean isConsolidated) This method retrieves all pending ledger entries for the given encumbrance
Iterator	findPendingLedgerEntries(Encumbrance encumbrance, boolean isApproved) This method retrieves all pending ledger entries for the given encumbrance
Iterator	findPendingLedgerEntriesForAccountBalance(Map fieldValues, boolean isApproved) This method retrieves all pending ledger entries that may belong to the given account balance record in the future
Iterator	findPendingLedgerEntriesForBalance(Map fieldValues, boolean isApproved) This method retrieves all pending ledger entries matching the given balance criteria
Iterator	findPendingLedgerEntriesForCashBalance(Map fieldValues, boolean isApproved) This method retrieves all pending ledger entries that may belong to cash balance in the future
Iterator	findPendingLedgerEntriesForEncumbrance(Map fieldValues, boolean isApproved) This method retrieves all pending ledger entries that may belong to encumbrance table in the future
Iterator	findPendingLedgerEntriesForEntry(Map fieldValues, boolean isApproved) This method retrieves all pending ledger entries matching the given entry criteria
Iterator	findPendingLedgerEntrySummaryForAccountBalance(Map fieldValues, boolean isApproved) This method retrieves all pending ledger entries that may belong to the given account balance record in the future
boolean	generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySource document) Invokes generateGeneralLedgerPendingEntries method on the transactional document.
org.kuali.rice.kns.util.KualiDecimal	getActualSummary(List universityFiscalYears, String chartOfAccountsCode, String accountNumber, boolean isDebit) This method...
org.kuali.rice.kns.util.KualiDecimal	getBudgetSummary(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String sufficientFundsObjectCode, boolean isYearEnd) This method...
GeneralLedgerPendingEntry	getByPrimaryId(Integer transactionEntrySequenceId, String documentHeaderId)
org.kuali.rice.kns.util.KualiDecimal	getCashSummary(List universityFiscalYears, String chartOfAccountsCode, String accountNumber, boolean isDebit) This method...
org.kuali.rice.kns.util.KualiDecimal	getEncumbranceSummary(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String sufficientFundsObjectCode, boolean isDebit, boolean isYearEnd) This method...
org.kuali.rice.kns.util.KualiDecimal	getExpenseSummary(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String sufficientFundsObjectCode, boolean isDebit, boolean isYearEnd) This method...
org.kuali.rice.kns.util.KualiDecimal	getOffsetToCashAmount(GeneralLedgerPostingDocument glPostingDocument) Adds up the amounts of all cash to offset GeneralLedgerPendingEntry records on the given AccountingDocument
boolean	hasPendingGeneralLedgerEntry(Account account) Does the given account have any general ledger entries? It is necessary to check this before closing an account.
boolean	isOffsetToCash(GeneralLedgerPendingEntry generalLedgerPendingEntry) Determines if the given GeneralLedgerPendingEntry represents offsets to cash
boolean	populateBankOffsetGeneralLedgerPendingEntry(Bank bank, org.kuali.rice.kns.util.KualiDecimal depositAmount, GeneralLedgerPostingDocument financialDocument, Integer universityFiscalYear, GeneralLedgerPendingEntrySequenceHelper sequenceHelper, GeneralLedgerPendingEntry bankOffsetEntry, String errorPropertyName) This populates an empty GeneralLedgerPendingEntry instance with default values for a bank offset.
void	populateExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySource poster, GeneralLedgerPendingEntrySourceDetail postable, GeneralLedgerPendingEntrySequenceHelper sequenceHelper, GeneralLedgerPendingEntry explicitEntry) This populates an empty GeneralLedgerPendingEntry explicitEntry object instance with default values.
boolean	populateOffsetGeneralLedgerPendingEntry(Integer universityFiscalYear, GeneralLedgerPendingEntry explicitEntry, GeneralLedgerPendingEntrySequenceHelper sequenceHelper, GeneralLedgerPendingEntry offsetEntry) This populates an GeneralLedgerPendingEntry offsetEntry object instance with values that differ from the values supplied in the explicit entry that it was cloned from.
void	save(GeneralLedgerPendingEntry generalLedgerPendingEntry)

Method Detail

getCashSummary

org.kuali.rice.kns.util.KualiDecimal getCashSummary(List universityFiscalYears,
                                                    String chartOfAccountsCode,
                                                    String accountNumber,
                                                    boolean isDebit)

This method...

Parameters:

universityFiscalYears -

chartOfAccountsCode -

accountNumber -

isDebit -

Returns:

getActualSummary

org.kuali.rice.kns.util.KualiDecimal getActualSummary(List universityFiscalYears,
                                                      String chartOfAccountsCode,
                                                      String accountNumber,
                                                      boolean isDebit)

This method...

Parameters:

universityFiscalYears -

chartOfAccountsCode -

accountNumber -

isDebit -

Returns:

getExpenseSummary

org.kuali.rice.kns.util.KualiDecimal getExpenseSummary(Integer universityFiscalYear,
                                                       String chartOfAccountsCode,
                                                       String accountNumber,
                                                       String sufficientFundsObjectCode,
                                                       boolean isDebit,
                                                       boolean isYearEnd)

This method...

Parameters:

universityFiscalYear -

chartOfAccountsCode -

accountNumber -

sufficientFundsObjectCode -

isDebit -

isYearEnd -

Returns:

getEncumbranceSummary

org.kuali.rice.kns.util.KualiDecimal getEncumbranceSummary(Integer universityFiscalYear,
                                                           String chartOfAccountsCode,
                                                           String accountNumber,
                                                           String sufficientFundsObjectCode,
                                                           boolean isDebit,
                                                           boolean isYearEnd)

This method...

Parameters:

universityFiscalYear -

chartOfAccountsCode -

accountNumber -

sufficientFundsObjectCode -

isDebit -

isYearEnd -

Returns:

getBudgetSummary

org.kuali.rice.kns.util.KualiDecimal getBudgetSummary(Integer universityFiscalYear,
                                                      String chartOfAccountsCode,
                                                      String accountNumber,
                                                      String sufficientFundsObjectCode,
                                                      boolean isYearEnd)

This method...

Parameters:

universityFiscalYear -

chartOfAccountsCode -

accountNumber -

sufficientFundsObjectCode -

isYearEnd -

Returns:

getByPrimaryId

GeneralLedgerPendingEntry getByPrimaryId(Integer transactionEntrySequenceId,
                                         String documentHeaderId)

Parameters:

transactionEntrySequenceId -

documentHeaderId -

generateGeneralLedgerPendingEntries

boolean generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySource document)

Invokes generateGeneralLedgerPendingEntries method on the transactional document.

Parameters:

document - - document whose pending entries need generated

Returns:

whether the business rules succeeded

fillInFiscalPeriodYear

void fillInFiscalPeriodYear(GeneralLedgerPendingEntry glpe)

The fiscal year and period is null in quite a few glpe's. This will put in a sensible default.

Parameters:

glpe -

save

void save(GeneralLedgerPendingEntry generalLedgerPendingEntry)

Parameters:

generalLedgerPendingEntry -

delete

void delete(String documentHeaderId)

Parameters:

documentHeaderId -

deleteByFinancialDocumentApprovedCode

void deleteByFinancialDocumentApprovedCode(String financialDocumentApprovedCode)

Delete all pending entries for a specific document approved code

Parameters:

financialDocumentApprovedCode -

hasPendingGeneralLedgerEntry

boolean hasPendingGeneralLedgerEntry(Account account)

Does the given account have any general ledger entries? It is necessary to check this before closing an account.

Parameters:

account -

Returns:

findApprovedPendingLedgerEntries

Iterator findApprovedPendingLedgerEntries()

The method finds all pending ledger entries

Returns:

all pending ledger entries

findPendingLedgerEntries

Iterator findPendingLedgerEntries(Encumbrance encumbrance,
                                  boolean isApproved)

This method retrieves all pending ledger entries for the given encumbrance

Parameters:

encumbrance - the encumbrance entry

isApproved - the flag that indicates whether the pending entries are approved or don't care

Returns:

all pending ledger entries of the given encumbrance

findPendingLedgerEntries

Iterator findPendingLedgerEntries(Balance balance,
                                  boolean isApproved,
                                  boolean isConsolidated)

This method retrieves all pending ledger entries for the given encumbrance

Parameters:

balance - the balance entry

isApproved - the flag that indicates whether the pending entries are approved or don't care

isConsolidated - determine whether the search results are consolidated

Returns:

all pending ledger entries of the given encumbrance

findPendingLedgerEntriesForEntry

Iterator findPendingLedgerEntriesForEntry(Map fieldValues,
                                          boolean isApproved)

This method retrieves all pending ledger entries matching the given entry criteria

Parameters:

isApproved - the flag that indicates whether the pending entries are approved or don't care

fieldValues - the input fields and values

Returns:

all pending ledger entries matching the given balance criteria

findPendingLedgerEntriesForBalance

Iterator findPendingLedgerEntriesForBalance(Map fieldValues,
                                            boolean isApproved)

This method retrieves all pending ledger entries matching the given balance criteria

Parameters:

isApproved - the flag that indicates whether the pending entries are approved or don't care

fieldValues - the input fields and values

Returns:

all pending ledger entries matching the given balance criteria

findPendingLedgerEntriesForCashBalance

Iterator findPendingLedgerEntriesForCashBalance(Map fieldValues,
                                                boolean isApproved)

This method retrieves all pending ledger entries that may belong to cash balance in the future

Parameters:

isApproved - the flag that indicates whether the pending entries are approved or don't care

Returns:

all pending ledger entries that may belong to cash balance

findPendingLedgerEntriesForEncumbrance

Iterator findPendingLedgerEntriesForEncumbrance(Map fieldValues,
                                                boolean isApproved)

This method retrieves all pending ledger entries that may belong to encumbrance table in the future

Parameters:

isApproved - the flag that indicates whether the pending entries are approved or don't care

Returns:

all pending ledger entries that may belong to encumbrance table

findPendingLedgerEntrySummaryForAccountBalance

Iterator findPendingLedgerEntrySummaryForAccountBalance(Map fieldValues,
                                                        boolean isApproved)

This method retrieves all pending ledger entries that may belong to the given account balance record in the future

Parameters:

fieldValues -

isApproved - the flag that indicates whether the pending entries are approved or don't care

Returns:

all pending ledger entries that may belong to encumbrance table

findPendingLedgerEntriesForAccountBalance

Iterator findPendingLedgerEntriesForAccountBalance(Map fieldValues,
                                                   boolean isApproved)

This method retrieves all pending ledger entries that may belong to the given account balance record in the future

Parameters:

fieldValues -

isApproved - the flag that indicates whether the pending entries are approved or don't care

Returns:

all pending ledger entries that may belong to encumbrance table

findPendingEntries

Collection findPendingEntries(Map fieldValues,
                              boolean isApproved)

Parameters:

fieldValues -

Returns:

populateExplicitGeneralLedgerPendingEntry

void populateExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySource poster,
                                               GeneralLedgerPendingEntrySourceDetail postable,
                                               GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
                                               GeneralLedgerPendingEntry explicitEntry)

This populates an empty GeneralLedgerPendingEntry explicitEntry object instance with default values.

Parameters:

accountingDocument -

accountingLine -

sequenceHelper -

explicitEntry -

buildGeneralLedgerPendingEntry

GeneralLedgerPendingEntry buildGeneralLedgerPendingEntry(GeneralLedgerPostingDocument document,
                                                         Account account,
                                                         ObjectCode objectCode,
                                                         String subAccountNumber,
                                                         String subObjectCode,
                                                         String organizationReferenceId,
                                                         String projectCode,
                                                         String referenceNumber,
                                                         String referenceTypeCode,
                                                         String referenceOriginCode,
                                                         String description,
                                                         boolean isDebit,
                                                         org.kuali.rice.kns.util.KualiDecimal amount,
                                                         GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

Convenience method to build a GLPE without a generalLedgerPendingEntrySourceDetail

Parameters:

document - a GeneralLedgerPostingDocument

account - the account for use in the GLPE

objectCode - the object code for use in the GLPE

subAccountNumber - the sub account number for use in the GLPE

subObjectCode - the subobject code for use in the GLPE

organizationReferenceId - the organization reference id to use in the GLPE

projectCode - the project code to use in the GLPE

referenceNumber - the reference number to use in the GLPE

referenceTypeCode - the reference type code to use in the GLPE

referenceOriginCode - the reference origin code to use in the GLPE

description - the description to put in the GLPE

isDebit - true if the GLPE represents a debit, false if it represents a credit

amount - the amount of the GLPE

sequenceHelper - the sequence helper to use

Returns:

a populated general ledger pending entry

populateOffsetGeneralLedgerPendingEntry

boolean populateOffsetGeneralLedgerPendingEntry(Integer universityFiscalYear,
                                                GeneralLedgerPendingEntry explicitEntry,
                                                GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
                                                GeneralLedgerPendingEntry offsetEntry)

This populates an GeneralLedgerPendingEntry offsetEntry object instance with values that differ from the values supplied in the explicit entry that it was cloned from. Note that the entries do not contain BOs now.

Parameters:

universityFiscalYear -

explicitEntry -

sequenceHelper -

offsetEntry - Cloned from the explicit entry

populateBankOffsetGeneralLedgerPendingEntry

boolean populateBankOffsetGeneralLedgerPendingEntry(Bank bank,
                                                    org.kuali.rice.kns.util.KualiDecimal depositAmount,
                                                    GeneralLedgerPostingDocument financialDocument,
                                                    Integer universityFiscalYear,
                                                    GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
                                                    GeneralLedgerPendingEntry bankOffsetEntry,
                                                    String errorPropertyName)

This populates an empty GeneralLedgerPendingEntry instance with default values for a bank offset. A global error will be posted as a side-effect if the given Bank has not defined the necessary bank offset relations.

Parameters:

bank -

depositAmount -

financialDocument -

universityFiscalYear -

sequenceHelper -

bankOffsetEntry -

errorPropertyName -

getOffsetToCashAmount

org.kuali.rice.kns.util.KualiDecimal getOffsetToCashAmount(GeneralLedgerPostingDocument glPostingDocument)

Adds up the amounts of all cash to offset GeneralLedgerPendingEntry records on the given AccountingDocument

Parameters:

glPostingDocument - the accounting document total the offset to cash amount for

Returns:

the offset to cash amount, where debited values have been subtracted and credited values have been added

isOffsetToCash

boolean isOffsetToCash(GeneralLedgerPendingEntry generalLedgerPendingEntry)

Determines if the given GeneralLedgerPendingEntry represents offsets to cash

Parameters:

generalLedgerPendingEntry - the GeneralLedgerPendingEntry to check

Returns:

true if the GeneralLedgerPendingEntry represents an offset to cash; false otherwise