org.kuali.kfs.gl.batch.dataaccess.impl
Class SufficientFundsDaoOjb

java.lang.Object
  org.springframework.dao.support.DaoSupport
      org.springmodules.orm.ojb.support.PersistenceBrokerDaoSupport
          org.kuali.rice.kns.dao.impl.PlatformAwareDaoBaseOjb
              org.kuali.kfs.gl.batch.dataaccess.impl.SufficientFundsDaoOjb

All Implemented Interfaces:

SufficientFundsDao, org.kuali.rice.kns.dao.PlatformAwareDao, org.springframework.beans.factory.InitializingBean

public class SufficientFundsDaoOjb
extends org.kuali.rice.kns.dao.impl.PlatformAwareDaoBaseOjb
implements SufficientFundsDao

An OJB implementation of SufficientFundsDao

Field Summary

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Constructor Summary

SufficientFundsDaoOjb()
Constructs a SufficientFundsDaoOjb instance

Method Summary

org.kuali.rice.kns.util.KualiDecimal	calculateM113PendActual(boolean financialBeginBalanceLoadInd, Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, List specialFinancialObjectCodes, String financialObjectCodeForCashInBank) Calculate the prior fiscal year pending actual amount
protected org.kuali.rice.kns.util.KualiDecimal	calculateM113PendActual1(boolean financialBeginBalanceLoadInd, Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, boolean isEqualDebitCode, String financialObjectCodeForCashInBank) calculate part of the actual total
protected org.kuali.rice.kns.util.KualiDecimal	calculateM113PendActual2(boolean financialBeginBalanceLoadInd, Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, boolean isEqualDebitCode, List specialFinancialObjectCodes) Calculate part of the actual total
org.kuali.rice.kns.util.KualiDecimal	calculateM113PfyrBudget(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber) Calculate the Prior Fiscal Year Budget total
org.kuali.rice.kns.util.KualiDecimal	calculateM113PfyrEncum(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber) Calculate the prior fiscal year encumbrance total
org.kuali.rice.kns.util.KualiDecimal	calculatePendActual(boolean isYearEndDocument, String actualFinancialBalanceTypeCd, Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String acctSufficientFundsFinObjCd, List expenditureCodes) Calculates the current pending actual
protected org.kuali.rice.kns.util.KualiDecimal	calculatePendActual1(boolean isYearEndDocument, String actualFinancialBalanceTypeCd, Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String acctSufficientFundsFinObjCd, boolean isEqualDebitCode, List expenditureCodes) Calculate this part of the actual total
org.kuali.rice.kns.util.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.kns.util.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
protected org.kuali.rice.kns.util.KualiDecimal	calculatePendEncum1(boolean isYearEndDocument, String extrnlEncumFinBalanceTypCd, String intrnlEncumFinBalanceTypCd, String preencumbranceFinBalTypeCd, Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String acctSufficientFundsFinObjCd, boolean isEqualDebitCode, List expenditureCodes) Calcluate this part of the encumbrance total
protected org.kuali.rice.kns.util.KualiDecimal	executeReportQuery(org.apache.ojb.broker.query.ReportQueryByCriteria reportQuery) This returns the very first value returned by a report query and then makes certain that OJB closes the connection that retrieved the query data
void	purgeYearByChart(String chartOfAccountsCode, int year) Purge table by year/chart

Methods inherited from class org.kuali.rice.kns.dao.impl.PlatformAwareDaoBaseOjb

getDbPlatform, setDbPlatform

Methods inherited from class org.springmodules.orm.ojb.support.PersistenceBrokerDaoSupport

checkDaoConfig, convertOjbAccessException, createPersistenceBrokerTemplate, getJcdAlias, getPersistenceBroker, getPersistenceBrokerTemplate, releasePersistenceBroker, setJcdAlias, setPersistenceBrokerTemplate

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

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

Constructor Detail

SufficientFundsDaoOjb

public SufficientFundsDaoOjb()

Constructs a SufficientFundsDaoOjb instance

Method Detail

calculateM113PfyrBudget

public org.kuali.rice.kns.util.KualiDecimal calculateM113PfyrBudget(Integer universityFiscalYear,
                                                                    String chartOfAccountsCode,
                                                                    String accountNumber)

Calculate the Prior Fiscal Year Budget total

Specified by:

calculateM113PfyrBudget in interface SufficientFundsDao

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

See Also:

SufficientFundsDao.calculateM113PfyrBudget(java.lang.Integer, java.lang.String, java.lang.String)

calculateM113PfyrEncum

public org.kuali.rice.kns.util.KualiDecimal calculateM113PfyrEncum(Integer universityFiscalYear,
                                                                   String chartOfAccountsCode,
                                                                   String accountNumber)

Calculate the prior fiscal year encumbrance total

Specified by:

calculateM113PfyrEncum in interface SufficientFundsDao

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 encumbrnace total

See Also:

SufficientFundsDao.calculateM113PfyrEncum(java.lang.Integer, java.lang.String, java.lang.String)

calculateM113PendActual

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

Calculate the prior fiscal year pending actual amount

Specified by:

calculateM113PendActual in interface SufficientFundsDao

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 - this actually doesn't seem to be used

financialObjectCodeForCashInBank - the object code for cash in the bank

Returns:

the prior fiscal year pending actual amount

See Also:

SufficientFundsDao.calculateM113PendActual(boolean, java.lang.Integer, java.lang.String, java.lang.String, List, String)

calculatePendActual

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

Calculates the current pending actual

Specified by:

calculatePendActual in interface SufficientFundsDao

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

See Also:

SufficientFundsDao.calculatePendActual(boolean, java.lang.String, java.lang.Integer, java.lang.String, java.lang.String, java.lang.String, List)

calculatePendBudget

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

calculates the current year pending budget total

Specified by:

calculatePendBudget in interface SufficientFundsDao

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

See Also:

SufficientFundsDao.calculatePendBudget(boolean, java.lang.String, java.lang.Integer, java.lang.String, java.lang.String, java.lang.String, List)

calculatePendEncum

public org.kuali.rice.kns.util.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

Specified by:

calculatePendEncum in interface SufficientFundsDao

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

See Also:

SufficientFundsDao.calculatePendEncum(boolean, java.lang.String, java.lang.String, java.lang.String, java.lang.Integer, java.lang.String, java.lang.String, java.lang.String, List)

calculatePendEncum1

protected org.kuali.rice.kns.util.KualiDecimal calculatePendEncum1(boolean isYearEndDocument,
                                                                   String extrnlEncumFinBalanceTypCd,
                                                                   String intrnlEncumFinBalanceTypCd,
                                                                   String preencumbranceFinBalTypeCd,
                                                                   Integer universityFiscalYear,
                                                                   String chartOfAccountsCode,
                                                                   String accountNumber,
                                                                   String acctSufficientFundsFinObjCd,
                                                                   boolean isEqualDebitCode,
                                                                   List expenditureCodes)

Calcluate this part of the 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

isEqualDebitCode - should debits be included in the calculation or not

Returns:

this part of the encumbrance total

calculatePendActual1

protected org.kuali.rice.kns.util.KualiDecimal calculatePendActual1(boolean isYearEndDocument,
                                                                    String actualFinancialBalanceTypeCd,
                                                                    Integer universityFiscalYear,
                                                                    String chartOfAccountsCode,
                                                                    String accountNumber,
                                                                    String acctSufficientFundsFinObjCd,
                                                                    boolean isEqualDebitCode,
                                                                    List expenditureCodes)

Calculate this part of the actual total

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

Returns:

this part of the actual total

calculateM113PendActual1

protected org.kuali.rice.kns.util.KualiDecimal calculateM113PendActual1(boolean financialBeginBalanceLoadInd,
                                                                        Integer universityFiscalYear,
                                                                        String chartOfAccountsCode,
                                                                        String accountNumber,
                                                                        boolean isEqualDebitCode,
                                                                        String financialObjectCodeForCashInBank)

calculate part of the actual 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:

thsi part of the actual total

calculateM113PendActual2

protected org.kuali.rice.kns.util.KualiDecimal calculateM113PendActual2(boolean financialBeginBalanceLoadInd,
                                                                        Integer universityFiscalYear,
                                                                        String chartOfAccountsCode,
                                                                        String accountNumber,
                                                                        boolean isEqualDebitCode,
                                                                        List specialFinancialObjectCodes)

Calculate part of the actual 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

isEqualDebitCode - should this query be returning debits or not?

specialFinancialObjectCodes - include only these financial object codes

Returns:

this part of the actual total

purgeYearByChart

public void purgeYearByChart(String chartOfAccountsCode,
                             int year)

Purge table by year/chart

Specified by:

purgeYearByChart in interface SufficientFundsDao

Parameters:

chart - the chart of sufficient fund balances to purge

year - the year of sufficient fund balances to purge

executeReportQuery

protected org.kuali.rice.kns.util.KualiDecimal executeReportQuery(org.apache.ojb.broker.query.ReportQueryByCriteria reportQuery)

This returns the very first value returned by a report query and then makes certain that OJB closes the connection that retrieved the query data

Parameters:

reportQuery - the ReportQuery to find the first value for

Returns:

the first value generated from the given query