org.kuali.kfs.gl.batch.dataaccess

Interface SufficientFundsDao

All Known Implementing Classes:

SufficientFundsDaoOjb

public interface SufficientFundsDao

A DAO interface. This one seems to refer to an old FIS issue, M113, which was: "On account sufficient funds checking, what needs to be done between beginning of fiscal year and loading of beginning balances?" Therefore, this DAO is to find year end balance totals, as far as I can tell

Method Summary

Methods

Modifier and Type	Method and Description
org.kuali.rice.core.api.util.type.KualiDecimal	calculateM113PendActual(boolean financialBeginBalanceLoadInd, Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, List specialFinancialObjectCodes, String financialObjectCodeForCashInBank) Calculate the prior fiscal year pending actual amount
org.kuali.rice.core.api.util.type.KualiDecimal	calculateM113PfyrBudget(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber) Calculate the Prior Fiscal Year Budget total
org.kuali.rice.core.api.util.type.KualiDecimal	calculateM113PfyrEncum(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber) Calculate the prior fiscal year encumbrnace total
org.kuali.rice.core.api.util.type.KualiDecimal	calculatePendActual(boolean isYearEndDocument, String actualFinancialBalanceTypeCd, Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String acctSufficientFundsFinObjCd, List expenditureCodes) Calculates the current pending actual
org.kuali.rice.core.api.util.type.KualiDecimal	calculatePendBudget(boolean isYearEndDocument, String budgetCheckingBalanceTypeCd, Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String acctSufficientFundsFinObjCd, List expenditureCodes) calculates the current year pending budget total
org.kuali.rice.core.api.util.type.KualiDecimal	calculatePendEncum(boolean isYearEndDocument, String extrnlEncumFinBalanceTypCd, String intrnlEncumFinBalanceTypCd, String preencumbranceFinBalTypeCd, Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String acctSufficientFundsFinObjCd, List expenditureCodes) Calculates the current year pending encumbrance total
void	purgeYearByChart(String chart, int year) Purge table by year/chart

Method Detail

calculateM113PfyrBudget

org.kuali.rice.core.api.util.type.KualiDecimal calculateM113PfyrBudget(Integer universityFiscalYear,
                                                                     String chartOfAccountsCode,
                                                                     String accountNumber)

Calculate the Prior Fiscal Year Budget total

Parameters:

universityFiscalYear - the university fiscal year of sufficient funds balances that will be summarized

chartOfAccountCode - the chart of accounts code of sufficient fund balance records that will be summarized

accountNumber - the account number of sufficient fund balances that will be summarized

Returns:

the sum of the prior fiscal year budget

calculateM113PfyrEncum

org.kuali.rice.core.api.util.type.KualiDecimal calculateM113PfyrEncum(Integer universityFiscalYear,
                                                                    String chartOfAccountsCode,
                                                                    String accountNumber)

Calculate the prior fiscal year encumbrnace total

Parameters:

universityFiscalYear - the university fiscal year of sufficient funds balances to summarize

chartOfAccountsCode - the chart of accounts code of sufficient funds balances to summarize

accountNumber - the account number of sufficient fund balances to summarize

Returns:

the prior fiscal year encumbrance total

calculateM113PendActual

org.kuali.rice.core.api.util.type.KualiDecimal calculateM113PendActual(boolean financialBeginBalanceLoadInd,
                                                                     Integer universityFiscalYear,
                                                                     String chartOfAccountsCode,
                                                                     String accountNumber,
                                                                     List specialFinancialObjectCodes,
                                                                     String financialObjectCodeForCashInBank)

Calculate the prior fiscal year pending actual amount

Parameters:

universityFiscalYear - the university fiscal year of sufficient funds balances to summarize

chartOfAccountsCode - the chart of accounts code of sufficient funds balances to summarize

accountNumber - the account number of sufficient fund balances to summarize

specialFinancialObjectCodes - include only these financial object codes

financialObjectCodeForCashInBank - the object code for cash in the bank

Returns:

the prior fiscal year pending actual amount

calculatePendActual

org.kuali.rice.core.api.util.type.KualiDecimal calculatePendActual(boolean isYearEndDocument,
                                                                 String actualFinancialBalanceTypeCd,
                                                                 Integer universityFiscalYear,
                                                                 String chartOfAccountsCode,
                                                                 String accountNumber,
                                                                 String acctSufficientFundsFinObjCd,
                                                                 List expenditureCodes)

Calculates the current pending actual

Parameters:

isYearEndDocument - should year end documents be included?

actualFinancialBalanceTypeCd - the actual balance type code

universityFiscalYear - the university fiscal year of sufficient funds balances to summarize

chartOfAccountsCode - the chart of accounts code of sufficient funds balances to summarize

accountNumber - the account number of sufficient fund balances to summarize

acctSufficientFundsFinObjCd - the object code for sufficient funds

expenditureCodes - object codes that represent expenditures

Returns:

the current pending actual total

calculatePendBudget

org.kuali.rice.core.api.util.type.KualiDecimal calculatePendBudget(boolean isYearEndDocument,
                                                                 String budgetCheckingBalanceTypeCd,
                                                                 Integer universityFiscalYear,
                                                                 String chartOfAccountsCode,
                                                                 String accountNumber,
                                                                 String acctSufficientFundsFinObjCd,
                                                                 List expenditureCodes)

calculates the current year pending budget total

Parameters:

isYearEndDocument - should year end documents be included?

budgetCheckingBalanceTypeCd - the budget balance type code

universityFiscalYear - the university fiscal year of sufficient funds balances to summarize

chartOfAccountsCode - the chart of accounts code of sufficient funds balances to summarize

accountNumber - the account number of sufficient fund balances to summarize

acctSufficientFundsFinObjCd - the object code for sufficient funds

expenditureCodes - object codes that represent expenditures

Returns:

calculates the current year pending budget total

calculatePendEncum

org.kuali.rice.core.api.util.type.KualiDecimal calculatePendEncum(boolean isYearEndDocument,
                                                                String extrnlEncumFinBalanceTypCd,
                                                                String intrnlEncumFinBalanceTypCd,
                                                                String preencumbranceFinBalTypeCd,
                                                                Integer universityFiscalYear,
                                                                String chartOfAccountsCode,
                                                                String accountNumber,
                                                                String acctSufficientFundsFinObjCd,
                                                                List expenditureCodes)

Calculates the current year pending encumbrance total

Parameters:

isYearEndDocument - should year end documents be included?

extrnlEncumFinBalanceTypCd - the external encumbrance balance type

intrnlEncumFinBalanceTypCd - the internal encumbrance balance type

preencumbranceFinBalTypeCd - the pre-encumbrance balance type

universityFiscalYear - the university fiscal year of sufficient funds balances to summarize

chartOfAccountsCode - the chart of accounts code of sufficient funds balances to summarize

accountNumber - the account number of sufficient fund balances to summarize

acctSufficientFundsFinObjCd - the object code for sufficient funds

expenditureCodes - object codes that represent expenditures

Returns:

the current year pending encumbrance total

purgeYearByChart

void purgeYearByChart(String chart,
                    int year)

Purge table by year/chart

Parameters:

chart - the chart of sufficient fund records to purge

year - the year of sufficient fund records to purge