org.kuali.ole.sys.service.impl

Class GeneralLedgerPendingEntryServiceImpl

java.lang.Object

org.kuali.ole.sys.service.impl.GeneralLedgerPendingEntryServiceImpl

All Implemented Interfaces:

GeneralLedgerPendingEntryService

@Transactional
public class GeneralLedgerPendingEntryServiceImpl
extends Object
implements GeneralLedgerPendingEntryService

This class is the service implementation for the GeneralLedgerPendingEntry structure. This is the default implementation, that is delivered with Kuali.

Field Summary

Fields

Modifier and Type	Field and Description
protected BalanceTypeService	balanceTypeService
protected ChartService	chartService
protected org.kuali.rice.kns.service.DataDictionaryService	dataDictionaryService
protected org.kuali.rice.core.api.datetime.DateTimeService	dateTimeService
protected GeneralLedgerPendingEntryDao	generalLedgerPendingEntryDao
protected org.kuali.rice.krad.service.KualiRuleService	kualiRuleService
protected OptionsService	optionsService
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	parameterService
protected org.kuali.rice.krad.service.PersistenceStructureService	persistenceStructureService
protected UniversityDateService	universityDateService

Constructor Summary

Constructors

Constructor and Description
GeneralLedgerPendingEntryServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
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.core.api.util.type.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
protected void	flexOffsetAccountIfNecessary(OffsetAccount flexibleOffsetAccount, GeneralLedgerPendingEntry offsetEntry) Applies the given flexible offset account to the given offset entry.
boolean	generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySource glpeSource) Invokes generateEntries method on the financial document.
org.kuali.rice.core.api.util.type.KualiDecimal	getActualSummary(List universityFiscalYears, String chartOfAccountsCode, String accountNumber, boolean isDebit) This method...
org.kuali.rice.core.api.util.type.KualiDecimal	getBudgetSummary(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String sufficientFundsObjectCode, boolean isYearEnd) This method...
GeneralLedgerPendingEntry	getByPrimaryId(Integer transactionEntrySequenceId, String documentHeaderId)
org.kuali.rice.core.api.util.type.KualiDecimal	getCashSummary(List universityFiscalYears, String chartOfAccountsCode, String accountNumber, boolean isDebit) This method...
List<String>	getEncumbranceBalanceTypes(Map fieldValues, Integer currentFiscalYear) Gets the encumbrance balance type.
org.kuali.rice.core.api.util.type.KualiDecimal	getEncumbranceSummary(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String sufficientFundsObjectCode, boolean isDebit, boolean isYearEnd) This method...
protected String	getEntryValue(String targetValue, String backupValue) A helper method that checks the intended target value for null and empty strings.
org.kuali.rice.core.api.util.type.KualiDecimal	getExpenseSummary(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String sufficientFundsObjectCode, boolean isDebit, boolean isYearEnd) This method...
protected String	getOffsetEntryDebitCreditCode(GeneralLedgerPendingEntry explicitEntry) Helper method that determines the debit/credit code for the offset entry.
protected String	getOffsetFinancialObjectCode(OffsetDefinition offsetDefinition) Helper method that determines the offset entry's financial object code.
protected String	getOffsetFinancialObjectTypeCode(OffsetDefinition offsetDefinition) Helper method that determines the offset entry's financial object type code.
org.kuali.rice.core.api.util.type.KualiDecimal	getOffsetToCashAmount(GeneralLedgerPostingDocument glPostingDocument) Adds up the amounts of all cash to offset GeneralLedgerPendingEntry records on the given AccountingDocument
org.kuali.rice.krad.service.PersistenceStructureService	getPersistenceStructureService() Gets the persistenceStructureService attribute.
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.core.api.util.type.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 glpeSource, GeneralLedgerPendingEntrySourceDetail glpeSourceDetail, 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)
void	setBalanceTypeService(BalanceTypeService balanceTypeService)
void	setChartService(ChartService chartService)
void	setDataDictionaryService(org.kuali.rice.kns.service.DataDictionaryService dataDictionaryService) Sets the dataDictionaryService attribute value.
void	setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService) Sets the dateTimeService attribute value.
void	setGeneralLedgerPendingEntryDao(GeneralLedgerPendingEntryDao generalLedgerPendingEntryDao)
void	setKualiRuleService(org.kuali.rice.krad.service.KualiRuleService kualiRuleService)
void	setOptionsService(OptionsService optionsService)
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)
void	setPersistenceStructureService(org.kuali.rice.krad.service.PersistenceStructureService persistenceStructureService) Sets the persistenceStructureService attribute value.
void	setUniversityDateService(UniversityDateService universityDateService) Sets the universityDateService.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

generalLedgerPendingEntryDao

protected GeneralLedgerPendingEntryDao generalLedgerPendingEntryDao

kualiRuleService

protected org.kuali.rice.krad.service.KualiRuleService kualiRuleService

chartService

protected ChartService chartService

optionsService

protected OptionsService optionsService

parameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService

balanceTypeService

protected BalanceTypeService balanceTypeService

dateTimeService

protected org.kuali.rice.core.api.datetime.DateTimeService dateTimeService

dataDictionaryService

protected org.kuali.rice.kns.service.DataDictionaryService dataDictionaryService

persistenceStructureService

protected org.kuali.rice.krad.service.PersistenceStructureService persistenceStructureService

universityDateService

protected UniversityDateService universityDateService

Constructor Detail

GeneralLedgerPendingEntryServiceImpl

public GeneralLedgerPendingEntryServiceImpl()

Method Detail

getExpenseSummary

public org.kuali.rice.core.api.util.type.KualiDecimal getExpenseSummary(Integer universityFiscalYear,
                                                               String chartOfAccountsCode,
                                                               String accountNumber,
                                                               String sufficientFundsObjectCode,
                                                               boolean isDebit,
                                                               boolean isYearEnd)

Description copied from interface: GeneralLedgerPendingEntryService

This method...

Specified by:

getExpenseSummary in interface GeneralLedgerPendingEntryService

Returns:

See Also:

org.kuali.module.gl.service.GeneralLedgerPendingEntryService#getExpenseSummary(java.util.List, java.lang.String, java.lang.String, boolean, boolean)

getEncumbranceSummary

public org.kuali.rice.core.api.util.type.KualiDecimal getEncumbranceSummary(Integer universityFiscalYear,
                                                                   String chartOfAccountsCode,
                                                                   String accountNumber,
                                                                   String sufficientFundsObjectCode,
                                                                   boolean isDebit,
                                                                   boolean isYearEnd)

Description copied from interface: GeneralLedgerPendingEntryService

This method...

Specified by:

getEncumbranceSummary in interface GeneralLedgerPendingEntryService

Returns:

See Also:

org.kuali.module.gl.service.GeneralLedgerPendingEntryService#getEncumbranceSummary(java.lang.Integer, java.lang.String, java.lang.String, java.lang.String, boolean, boolean)

getBudgetSummary

public org.kuali.rice.core.api.util.type.KualiDecimal getBudgetSummary(Integer universityFiscalYear,
                                                              String chartOfAccountsCode,
                                                              String accountNumber,
                                                              String sufficientFundsObjectCode,
                                                              boolean isYearEnd)

Description copied from interface: GeneralLedgerPendingEntryService

This method...

Specified by:

getBudgetSummary in interface GeneralLedgerPendingEntryService

Returns:

See Also:

org.kuali.module.gl.service.GeneralLedgerPendingEntryService#getBudgetSummary(java.lang.Integer, java.lang.String, java.lang.String, java.lang.String, boolean)

getCashSummary

public org.kuali.rice.core.api.util.type.KualiDecimal getCashSummary(List universityFiscalYears,
                                                            String chartOfAccountsCode,
                                                            String accountNumber,
                                                            boolean isDebit)

Description copied from interface: GeneralLedgerPendingEntryService

This method...

Specified by:

getCashSummary in interface GeneralLedgerPendingEntryService

Returns:

See Also:

org.kuali.module.gl.service.GeneralLedgerPendingEntryService#getCashSummary(java.util.Collection, java.lang.String, java.lang.String, boolean)

getActualSummary

public org.kuali.rice.core.api.util.type.KualiDecimal getActualSummary(List universityFiscalYears,
                                                              String chartOfAccountsCode,
                                                              String accountNumber,
                                                              boolean isDebit)

Description copied from interface: GeneralLedgerPendingEntryService

This method...

Specified by:

getActualSummary in interface GeneralLedgerPendingEntryService

Returns:

See Also:

org.kuali.module.gl.service.GeneralLedgerPendingEntryService#getActualSummary(java.util.List, java.lang.String, java.lang.String, boolean)

getByPrimaryId

public GeneralLedgerPendingEntry getByPrimaryId(Integer transactionEntrySequenceId,
                                       String documentHeaderId)

Specified by:

getByPrimaryId in interface GeneralLedgerPendingEntryService

See Also:

org.kuali.module.gl.service.GeneralLedgerPendingEntryService#getByPrimaryId(java.lang.Integer, java.lang.String)

fillInFiscalPeriodYear

public void fillInFiscalPeriodYear(GeneralLedgerPendingEntry glpe)

Description copied from interface: GeneralLedgerPendingEntryService

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

Specified by:

fillInFiscalPeriodYear in interface GeneralLedgerPendingEntryService

generateGeneralLedgerPendingEntries

public boolean generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySource glpeSource)

Invokes generateEntries method on the financial document.

Specified by:

generateGeneralLedgerPendingEntries in interface GeneralLedgerPendingEntryService

Parameters:

document - - document whose pending entries need generated

Returns:

whether the business rules succeeded

populateExplicitGeneralLedgerPendingEntry

public void populateExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySource glpeSource,
                                             GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
                                             GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
                                             GeneralLedgerPendingEntry explicitEntry)

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

Specified by:

populateExplicitGeneralLedgerPendingEntry in interface GeneralLedgerPendingEntryService

Parameters:

accountingDocument -

accountingLine -

sequenceHelper -

explicitEntry -

buildGeneralLedgerPendingEntry

public 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.core.api.util.type.KualiDecimal amount,
                                                       GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

Convenience method to build a GLPE without a generalLedgerPendingEntrySourceDetail

Specified by:

buildGeneralLedgerPendingEntry in interface GeneralLedgerPendingEntryService

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

public 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.

Specified by:

populateOffsetGeneralLedgerPendingEntry in interface GeneralLedgerPendingEntryService

Parameters:

universityFiscalYear -

explicitEntry -

sequenceHelper -

offsetEntry - Cloned from the explicit entry

Returns:

whether the offset generation is successful

flexOffsetAccountIfNecessary

protected void flexOffsetAccountIfNecessary(OffsetAccount flexibleOffsetAccount,
                                GeneralLedgerPendingEntry offsetEntry)

Applies the given flexible offset account to the given offset entry. Does nothing if flexibleOffsetAccount is null or its COA and account number are the same as the offset entry's.

Parameters:

flexibleOffsetAccount - may be null

offsetEntry - may be modified

getOffsetFinancialObjectTypeCode

protected String getOffsetFinancialObjectTypeCode(OffsetDefinition offsetDefinition)

Helper method that determines the offset entry's financial object type code.

Parameters:

offsetDefinition -

Returns:

String

getOffsetEntryDebitCreditCode

protected String getOffsetEntryDebitCreditCode(GeneralLedgerPendingEntry explicitEntry)

Helper method that determines the debit/credit code for the offset entry. If the explicit was a debit, the offset is a credit. Otherwise, it's opposite.

Parameters:

explicitEntry -

Returns:

String

getOffsetFinancialObjectCode

protected String getOffsetFinancialObjectCode(OffsetDefinition offsetDefinition)

Helper method that determines the offset entry's financial object code.

Parameters:

offsetDefinition -

Returns:

String

populateBankOffsetGeneralLedgerPendingEntry

public boolean populateBankOffsetGeneralLedgerPendingEntry(Bank bank,
                                                  org.kuali.rice.core.api.util.type.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.

Specified by:

populateBankOffsetGeneralLedgerPendingEntry in interface GeneralLedgerPendingEntryService

Parameters:

bank -

depositAmount -

financialDocument -

universityFiscalYear -

sequenceHelper -

bankOffsetEntry -

errorPropertyName -

Returns:

whether the entry was populated successfully

save

public void save(GeneralLedgerPendingEntry generalLedgerPendingEntry)

Specified by:

save in interface GeneralLedgerPendingEntryService

See Also:

GeneralLedgerPendingEntryService.save(org.kuali.ole.sys.businessobject.GeneralLedgerPendingEntry)

delete

public void delete(String documentHeaderId)

Specified by:

delete in interface GeneralLedgerPendingEntryService

deleteByFinancialDocumentApprovedCode

public void deleteByFinancialDocumentApprovedCode(String financialDocumentApprovedCode)

Description copied from interface: GeneralLedgerPendingEntryService

Delete all pending entries for a specific document approved code

Specified by:

deleteByFinancialDocumentApprovedCode in interface GeneralLedgerPendingEntryService

findApprovedPendingLedgerEntries

public Iterator findApprovedPendingLedgerEntries()

Description copied from interface: GeneralLedgerPendingEntryService

The method finds all pending ledger entries

Specified by:

findApprovedPendingLedgerEntries in interface GeneralLedgerPendingEntryService

Returns:

all pending ledger entries

See Also:

org.kuali.module.gl.service.GeneralLedgerPendingEntryService#findApprovedPendingLedgerEntries()

findPendingLedgerEntries

public Iterator findPendingLedgerEntries(Encumbrance encumbrance,
                                boolean isApproved)

Description copied from interface: GeneralLedgerPendingEntryService

This method retrieves all pending ledger entries for the given encumbrance

Specified by:

findPendingLedgerEntries in interface GeneralLedgerPendingEntryService

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

See Also:

org.kuali.module.gl.service.GeneralLedgerPendingEntryService#findPendingLedgerEntries(org.kuali.ole.gl.businessobject.Encumbrance, boolean)

hasPendingGeneralLedgerEntry

public boolean hasPendingGeneralLedgerEntry(Account account)

Description copied from interface: GeneralLedgerPendingEntryService

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

Specified by:

hasPendingGeneralLedgerEntry in interface GeneralLedgerPendingEntryService

Returns:

See Also:

org.kuali.module.gl.service.GeneralLedgerPendingEntryService#hasPendingGeneralLedgerEntry(org.kuali.ole.coa.businessobject.Account)

findPendingLedgerEntries

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

Description copied from interface: GeneralLedgerPendingEntryService

This method retrieves all pending ledger entries for the given encumbrance

Specified by:

findPendingLedgerEntries in interface GeneralLedgerPendingEntryService

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

See Also:

org.kuali.module.gl.service.GeneralLedgerPendingEntryService#findPendingLedgerEntries(Balance, boolean, boolean)

findPendingLedgerEntriesForEntry

public Iterator findPendingLedgerEntriesForEntry(Map fieldValues,
                                        boolean isApproved)

Description copied from interface: GeneralLedgerPendingEntryService

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

Specified by:

findPendingLedgerEntriesForEntry in interface GeneralLedgerPendingEntryService

Parameters:

fieldValues - the input fields and values

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

Returns:

all pending ledger entries matching the given balance criteria

See Also:

org.kuali.module.gl.service.GeneralLedgerPendingEntryService#findPendingLedgerEntriesForEntry(java.util.Map, boolean)

findPendingLedgerEntriesForEncumbrance

public Iterator findPendingLedgerEntriesForEncumbrance(Map fieldValues,
                                              boolean isApproved)

Description copied from interface: GeneralLedgerPendingEntryService

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

Specified by:

findPendingLedgerEntriesForEncumbrance in interface GeneralLedgerPendingEntryService

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

See Also:

org.kuali.module.gl.service.GeneralLedgerPendingEntryService#findPendingLedgerEntriesForEncumbrance(Map, boolean)

findPendingLedgerEntriesForCashBalance

public Iterator findPendingLedgerEntriesForCashBalance(Map fieldValues,
                                              boolean isApproved)

Description copied from interface: GeneralLedgerPendingEntryService

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

Specified by:

findPendingLedgerEntriesForCashBalance in interface GeneralLedgerPendingEntryService

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

See Also:

org.kuali.module.gl.service.GeneralLedgerPendingEntryService#findPendingLedgerEntriesForCashBalance(java.util.Map, boolean)

findPendingLedgerEntriesForBalance

public Iterator findPendingLedgerEntriesForBalance(Map fieldValues,
                                          boolean isApproved)

Description copied from interface: GeneralLedgerPendingEntryService

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

Specified by:

findPendingLedgerEntriesForBalance in interface GeneralLedgerPendingEntryService

Parameters:

fieldValues - the input fields and values

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

Returns:

all pending ledger entries matching the given balance criteria

See Also:

org.kuali.module.gl.service.GeneralLedgerPendingEntryService#findPendingLedgerEntriesForBalance(java.util.Map, boolean)

findPendingLedgerEntriesForAccountBalance

public Iterator findPendingLedgerEntriesForAccountBalance(Map fieldValues,
                                                 boolean isApproved)

Description copied from interface: GeneralLedgerPendingEntryService

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

Specified by:

findPendingLedgerEntriesForAccountBalance in interface GeneralLedgerPendingEntryService

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

See Also:

org.kuali.module.gl.service.GeneralLedgerPendingEntryService#findPendingLedgerEntriesForAccountBalance(java.util.Map, boolean, boolean)

findPendingLedgerEntrySummaryForAccountBalance

public Iterator findPendingLedgerEntrySummaryForAccountBalance(Map fieldValues,
                                                      boolean isApproved)

Description copied from interface: GeneralLedgerPendingEntryService

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

Specified by:

findPendingLedgerEntrySummaryForAccountBalance in interface GeneralLedgerPendingEntryService

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

See Also:

org.kuali.module.gl.service.GeneralLedgerPendingEntryService#findPendingLedgerEntrySummaryForAccountBalance(java.util.Map, boolean, boolean)

findPendingEntries

public Collection findPendingEntries(Map fieldValues,
                            boolean isApproved)

Specified by:

findPendingEntries in interface GeneralLedgerPendingEntryService

Returns:

getEntryValue

protected final String getEntryValue(String targetValue,
                   String backupValue)

A helper method that checks the intended target value for null and empty strings. If the intended target value is not null or an empty string, it returns that value, ohterwise, it returns a backup value.

Parameters:

targetValue -

backupValue -

Returns:

String

isOffsetToCash

public boolean isOffsetToCash(GeneralLedgerPendingEntry generalLedgerPendingEntry)

Determines if the given GeneralLedgerPendingEntry represents offsets to cash

Specified by:

isOffsetToCash in interface GeneralLedgerPendingEntryService

Parameters:

generalLedgerPendingEntry - the GeneralLedgerPendingEntry to check

Returns:

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

getOffsetToCashAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getOffsetToCashAmount(GeneralLedgerPostingDocument glPostingDocument)

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

Specified by:

getOffsetToCashAmount in interface GeneralLedgerPendingEntryService

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

getEncumbranceBalanceTypes

public List<String> getEncumbranceBalanceTypes(Map fieldValues,
                                      Integer currentFiscalYear)

Description copied from interface: GeneralLedgerPendingEntryService

Gets the encumbrance balance type. It returns the encumbrance balance type for the given universityFiscalYear if one is passed in the fieldValues or the current year encumbrance balance types.

Specified by:

getEncumbranceBalanceTypes in interface GeneralLedgerPendingEntryService

Returns:

the encumbrance balance type for the given universityFiscalYear if one is passed in the fieldValues or the current year encumbrance balance types.

See Also:

GeneralLedgerPendingEntryService.getEncumbranceBalanceTypes(java.util.Map, java.lang.Integer)

setBalanceTypeService

public void setBalanceTypeService(BalanceTypeService balanceTypeService)

setChartService

public void setChartService(ChartService chartService)

setGeneralLedgerPendingEntryDao

public void setGeneralLedgerPendingEntryDao(GeneralLedgerPendingEntryDao generalLedgerPendingEntryDao)

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)

setKualiRuleService

public void setKualiRuleService(org.kuali.rice.krad.service.KualiRuleService kualiRuleService)

setOptionsService

public void setOptionsService(OptionsService optionsService)

setDateTimeService

public void setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)

Sets the dateTimeService attribute value.

Parameters:

dateTimeService - The dateTimeService to set.

setDataDictionaryService

public void setDataDictionaryService(org.kuali.rice.kns.service.DataDictionaryService dataDictionaryService)

Sets the dataDictionaryService attribute value.

Parameters:

dataDictionaryService - The dataDictionaryService to set.

getPersistenceStructureService

public org.kuali.rice.krad.service.PersistenceStructureService getPersistenceStructureService()

Gets the persistenceStructureService attribute.

Returns:

Returns the persistenceStructureService.

setPersistenceStructureService

public void setPersistenceStructureService(org.kuali.rice.krad.service.PersistenceStructureService persistenceStructureService)

Sets the persistenceStructureService attribute value.

Parameters:

persistenceStructureService - The persistenceStructureService to set.

setUniversityDateService

public void setUniversityDateService(UniversityDateService universityDateService)

Sets the universityDateService.

Parameters:

universityDateService -