org.kuali.kfs.module.bc.document.dataaccess.impl
Class BudgetConstructionDaoOjb

java.lang.Object
  org.springframework.dao.support.DaoSupport
      org.springmodules.orm.ojb.support.PersistenceBrokerDaoSupport
          org.kuali.rice.kns.dao.impl.PlatformAwareDaoBaseOjb
              org.kuali.kfs.module.bc.document.dataaccess.impl.BudgetConstructionDaoOjb

All Implemented Interfaces:

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

public class BudgetConstructionDaoOjb
extends org.kuali.rice.kns.dao.impl.PlatformAwareDaoBaseOjb
implements BudgetConstructionDao

This class is the OJB implementation of the BudgetConstructionDao interface.

Field Summary

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

logger

Constructor Summary

BudgetConstructionDaoOjb()

Method Summary

void	deleteBudgetConstructionFundingLock(BudgetConstructionFundingLock budgetConstructionFundingLock) This deletes a BudgetConstructionFundingLock from the database
void	deleteBudgetConstructionPullupByUserId(String principalName) This method deletes all BudgetConstructionPullup rows associated with a user.
void	deleteExistingAccountOrganizationHierarchy(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber) deletes an existing set of Account Organization Hierarchy objects from the DB for the account key passed in
List<BudgetConstructionAccountOrganizationHierarchy>	getAccountOrgHierForAccount(String chartOfAccountsCode, String accountNumber, Integer universityFiscalYear) Returns a list of account organization hierarchy levels for an account
BudgetConstructionAccountReports	getAccountReports(String chartOfAccountsCode, String accountNumber) Returns a BudgetConstructionAccountReports object for the given key.
List<PendingBudgetConstructionAppointmentFunding>	getAllFundingForPosition(Integer universityFiscalYear, String positionNumber) Retrieves all PendingBudgetConstructionAppointmentFunding records for the given position key.
List<BudgetConstructionPullup>	getBudgetConstructionPullupChildOrgs(String principalId, String chartOfAccountsCode, String organizationCode) This returns a list of BudgetConstructionPullup objects (organizations) that are children to the passed in organization for the user
List<BudgetConstructionPullup>	getBudgetConstructionPullupFlagSetByUserId(String principalName) This method returns a list of BudgetConstructionPullup objects (organizations) ownded by the user that have the pullflag set
BudgetConstructionHeader	getByCandidateKey(String chartOfAccountsCode, String accountNumber, String subAccountNumber, Integer fiscalYear) This gets a BudgetConstructionHeader using the candidate key chart, account, subaccount, fiscalyear
BudgetConstructionPosition	getByPrimaryId(String positionNumber, Integer fiscalYear) Gets a BudgetConstructionPosition from the database by the primary key positionNumber, fiscalYear
BudgetConstructionFundingLock	getByPrimaryId(String chartOfAccountsCode, String accountNumber, String subAccountNumber, Integer fiscalYear, String principalId) This gets a BudgetConstructionFundingLock using the primary key chart, account, subaccount, fiscalyear, pUId
org.kuali.rice.kns.service.DataDictionaryService	getDataDictionaryService() Gets the dataDictionaryService attribute.
List<String>	getDetailSalarySettingLaborObjects(Integer universityFiscalYear, String chartOfAccountsCode) Returns a list of labor objects that are Salary Setting detail related
List	getDocumentPBGLFringeLines(String documentNumber, List fringeObjects) returns a list of fringe benefit accounting lines for a document
Collection<BudgetConstructionFundingLock>	getFlocksForAccount(String chartOfAccountsCode, String accountNumber, String subAccountNumber, Integer fiscalYear) This gets the set of BudgetConstructionFundingLocks asssociated with a BC EDoc (account).
BudgetConstructionOrganizationReports	getOrganizationReports(String chartOfAccountsCode, String organizationCode) Returns a BudgetConstructionOrganizationReports object for the given key.
List	getPBGLSalarySettingRows(String documentNumber, List salarySettingObjects) Returns a list of Pending Budget GL rows that are Salary Setting detail related, based on the set of salarySettingObjects passed in
org.kuali.rice.kns.util.KualiInteger	getPendingBudgetConstructionAppointmentFundingRequestSum(PendingBudgetConstructionGeneralLedger salaryDetailLine) Returns the sum of the salary detail request amounts for an accounting line
String	getPositionAssociatedWithFundingLock(BudgetConstructionFundingLock budgetConstructionFundingLock) Returns the position number associated with a funding lock or the not found string if the lock is an orphan.
boolean	insertAccountIntoAccountOrganizationHierarchy(String rootChart, String rootOrganization, Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, Integer currentLevelCode, String organizationChartOfAccountsCode, String organizationCode) Builds an Account Organization Hierarchy by recursively calling itself inserting each Hierarchy row (BudgetConstructionAccountOrganizationHierarchy) while walking the organization reports to structure (BudgetConstructionOrganizationReports) stopping at the root of the organization tree or overflow value, whatever comes first.
boolean	isDelegate(String chartOfAccountsCode, String accountNumber, String principalId) Determines is a user is an active Budget Construction document delegate approver for the Budget Construction document type or the 'ALL' document type
void	saveBudgetConstructionDocument(BudgetConstructionDocument bcDocument) Save a BudgetConstructionDocument object to the database
void	saveBudgetConstructionFundingLock(BudgetConstructionFundingLock budgetConstructionFundingLock) This saves a BudgetConstructionFundingLock to the database
void	saveBudgetConstructionHeader(BudgetConstructionHeader bcHeader) This saves a BudgetConstructionHeader object to the database
void	saveBudgetConstructionPosition(BudgetConstructionPosition bcPosition) Saves a BudgetConstructionPosition to the database
void	setDataDictionaryService(org.kuali.rice.kns.service.DataDictionaryService dataDictionaryService) Sets the dataDictionaryService attribute value.
void	setKualiModuleService(org.kuali.rice.kns.service.KualiModuleService kualiModuleService) Sets the kualiModuleService attribute value.

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

BudgetConstructionDaoOjb

public BudgetConstructionDaoOjb()

Method Detail

getByCandidateKey

public BudgetConstructionHeader getByCandidateKey(String chartOfAccountsCode,
                                                  String accountNumber,
                                                  String subAccountNumber,
                                                  Integer fiscalYear)

This gets a BudgetConstructionHeader using the candidate key chart, account, subaccount, fiscalyear

Specified by:

getByCandidateKey in interface BudgetConstructionDao

Parameters:

chartOfAccountsCode -

accountNumber -

subAccountNumber -

fiscalYear -

Returns:

BudgetConstructionHeader

saveBudgetConstructionHeader

public void saveBudgetConstructionHeader(BudgetConstructionHeader bcHeader)

This saves a BudgetConstructionHeader object to the database

Specified by:

saveBudgetConstructionHeader in interface BudgetConstructionDao

Parameters:

bcHeader -

saveBudgetConstructionDocument

public void saveBudgetConstructionDocument(BudgetConstructionDocument bcDocument)

Description copied from interface: BudgetConstructionDao

Save a BudgetConstructionDocument object to the database

Specified by:

saveBudgetConstructionDocument in interface BudgetConstructionDao

See Also:

BudgetConstructionDao.saveBudgetConstructionDocument(org.kuali.kfs.module.bc.document.BudgetConstructionDocument)

getByPrimaryId

public BudgetConstructionFundingLock getByPrimaryId(String chartOfAccountsCode,
                                                    String accountNumber,
                                                    String subAccountNumber,
                                                    Integer fiscalYear,
                                                    String principalId)

This gets a BudgetConstructionFundingLock using the primary key chart, account, subaccount, fiscalyear, pUId

Specified by:

getByPrimaryId in interface BudgetConstructionDao

Parameters:

chartOfAccountsCode -

accountNumber -

subAccountNumber -

fiscalYear -

principalId -

Returns:

BudgetConstructionFundingLock

saveBudgetConstructionFundingLock

public void saveBudgetConstructionFundingLock(BudgetConstructionFundingLock budgetConstructionFundingLock)

This saves a BudgetConstructionFundingLock to the database

Specified by:

saveBudgetConstructionFundingLock in interface BudgetConstructionDao

Parameters:

budgetConstructionFundingLock -

deleteBudgetConstructionFundingLock

public void deleteBudgetConstructionFundingLock(BudgetConstructionFundingLock budgetConstructionFundingLock)

This deletes a BudgetConstructionFundingLock from the database

Specified by:

deleteBudgetConstructionFundingLock in interface BudgetConstructionDao

Parameters:

budgetConstructionFundingLock -

getFlocksForAccount

public Collection<BudgetConstructionFundingLock> getFlocksForAccount(String chartOfAccountsCode,
                                                                     String accountNumber,
                                                                     String subAccountNumber,
                                                                     Integer fiscalYear)

This gets the set of BudgetConstructionFundingLocks asssociated with a BC EDoc (account). Each BudgetConstructionFundingLock has the positionNumber dummy attribute set to the associated Position that is locked. A positionNumber value of "NotFnd" indicates the BudgetConstructionFundingLock is an orphan.

Specified by:

getFlocksForAccount in interface BudgetConstructionDao

Parameters:

chartOfAccountsCode -

accountNumber -

subAccountNumber -

fiscalYear -

Returns:

Collection

getPositionAssociatedWithFundingLock

public String getPositionAssociatedWithFundingLock(BudgetConstructionFundingLock budgetConstructionFundingLock)

Description copied from interface: BudgetConstructionDao

Returns the position number associated with a funding lock or the not found string if the lock is an orphan.

Specified by:

getPositionAssociatedWithFundingLock in interface BudgetConstructionDao

Parameters:

budgetConstructionFundingLock - - funding lock to get position for

Returns:

position number associated with lock

See Also:

BudgetConstructionDao.getPositionAssociatedWithFundingLock(org.kuali.kfs.module.bc.businessobject.BudgetConstructionFundingLock)

getByPrimaryId

public BudgetConstructionPosition getByPrimaryId(String positionNumber,
                                                 Integer fiscalYear)

Gets a BudgetConstructionPosition from the database by the primary key positionNumber, fiscalYear

Specified by:

getByPrimaryId in interface BudgetConstructionDao

Parameters:

positionNumber -

fiscalYear -

Returns:

BudgetConstructionPosition

saveBudgetConstructionPosition

public void saveBudgetConstructionPosition(BudgetConstructionPosition bcPosition)

Saves a BudgetConstructionPosition to the database

Specified by:

saveBudgetConstructionPosition in interface BudgetConstructionDao

Parameters:

bcPosition -

deleteBudgetConstructionPullupByUserId

public void deleteBudgetConstructionPullupByUserId(String principalName)

Description copied from interface: BudgetConstructionDao

This method deletes all BudgetConstructionPullup rows associated with a user.

Specified by:

deleteBudgetConstructionPullupByUserId in interface BudgetConstructionDao

See Also:

BudgetConstructionDao.deleteBudgetConstructionPullupByUserId(java.lang.String)

getBudgetConstructionPullupFlagSetByUserId

public List<BudgetConstructionPullup> getBudgetConstructionPullupFlagSetByUserId(String principalName)

Description copied from interface: BudgetConstructionDao

This method returns a list of BudgetConstructionPullup objects (organizations) ownded by the user that have the pullflag set

Specified by:

getBudgetConstructionPullupFlagSetByUserId in interface BudgetConstructionDao

Returns:

See Also:

BudgetConstructionDao.getBudgetConstructionPullupFlagSetByUserId(java.lang.String)

getBudgetConstructionPullupChildOrgs

public List<BudgetConstructionPullup> getBudgetConstructionPullupChildOrgs(String principalId,
                                                                           String chartOfAccountsCode,
                                                                           String organizationCode)

Description copied from interface: BudgetConstructionDao

This returns a list of BudgetConstructionPullup objects (organizations) that are children to the passed in organization for the user

Specified by:

getBudgetConstructionPullupChildOrgs in interface BudgetConstructionDao

Returns:

See Also:

org.kuali.kfs.module.bc.document.dataaccess.BudgetConstructionDao#getBcPullupChildOrgs(java.lang.String, java.lang.String, java.lang.String)

getPendingBudgetConstructionAppointmentFundingRequestSum

public org.kuali.rice.kns.util.KualiInteger getPendingBudgetConstructionAppointmentFundingRequestSum(PendingBudgetConstructionGeneralLedger salaryDetailLine)

Description copied from interface: BudgetConstructionDao

Returns the sum of the salary detail request amounts for an accounting line

Specified by:

getPendingBudgetConstructionAppointmentFundingRequestSum in interface BudgetConstructionDao

Returns:

See Also:

BudgetConstructionDao.getPendingBudgetConstructionAppointmentFundingRequestSum(org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionGeneralLedger)

getDocumentPBGLFringeLines

public List getDocumentPBGLFringeLines(String documentNumber,
                                       List fringeObjects)

Description copied from interface: BudgetConstructionDao

returns a list of fringe benefit accounting lines for a document

Specified by:

getDocumentPBGLFringeLines in interface BudgetConstructionDao

Returns:

See Also:

BudgetConstructionDao.getDocumentPBGLFringeLines(java.lang.String, java.util.List)

isDelegate

public boolean isDelegate(String chartOfAccountsCode,
                          String accountNumber,
                          String principalId)

Description copied from interface: BudgetConstructionDao

Determines is a user is an active Budget Construction document delegate approver for the Budget Construction document type or the 'ALL' document type

Specified by:

isDelegate in interface BudgetConstructionDao

Returns:

See Also:

BudgetConstructionDao.isDelegate(java.lang.String, java.lang.String, java.lang.String)

getAccountOrgHierForAccount

public List<BudgetConstructionAccountOrganizationHierarchy> getAccountOrgHierForAccount(String chartOfAccountsCode,
                                                                                        String accountNumber,
                                                                                        Integer universityFiscalYear)

Description copied from interface: BudgetConstructionDao

Returns a list of account organization hierarchy levels for an account

Specified by:

getAccountOrgHierForAccount in interface BudgetConstructionDao

Returns:

See Also:

BudgetConstructionDao.getAccountOrgHierForAccount(java.lang.String, java.lang.String, java.lang.Integer)

getAccountReports

public BudgetConstructionAccountReports getAccountReports(String chartOfAccountsCode,
                                                          String accountNumber)

Description copied from interface: BudgetConstructionDao

Returns a BudgetConstructionAccountReports object for the given key.

Specified by:

getAccountReports in interface BudgetConstructionDao

Returns:

See Also:

BudgetConstructionDao.getAccountReports(java.lang.String, java.lang.String)

getOrganizationReports

public BudgetConstructionOrganizationReports getOrganizationReports(String chartOfAccountsCode,
                                                                    String organizationCode)

Description copied from interface: BudgetConstructionDao

Returns a BudgetConstructionOrganizationReports object for the given key.

Specified by:

getOrganizationReports in interface BudgetConstructionDao

Returns:

See Also:

BudgetConstructionDao.getOrganizationReports(java.lang.String, java.lang.String)

insertAccountIntoAccountOrganizationHierarchy

public boolean insertAccountIntoAccountOrganizationHierarchy(String rootChart,
                                                             String rootOrganization,
                                                             Integer universityFiscalYear,
                                                             String chartOfAccountsCode,
                                                             String accountNumber,
                                                             Integer currentLevelCode,
                                                             String organizationChartOfAccountsCode,
                                                             String organizationCode)

Description copied from interface: BudgetConstructionDao

Builds an Account Organization Hierarchy by recursively calling itself inserting each Hierarchy row (BudgetConstructionAccountOrganizationHierarchy) while walking the organization reports to structure (BudgetConstructionOrganizationReports) stopping at the root of the organization tree or overflow value, whatever comes first.

Specified by:

insertAccountIntoAccountOrganizationHierarchy in interface BudgetConstructionDao

Returns:

See Also:

BudgetConstructionDao.insertAccountIntoAccountOrganizationHierarchy(java.lang.String, java.lang.String, java.lang.Integer, java.lang.String, java.lang.String, java.lang.Integer, java.lang.String, java.lang.String)

deleteExistingAccountOrganizationHierarchy

public void deleteExistingAccountOrganizationHierarchy(Integer universityFiscalYear,
                                                       String chartOfAccountsCode,
                                                       String accountNumber)

Description copied from interface: BudgetConstructionDao

deletes an existing set of Account Organization Hierarchy objects from the DB for the account key passed in

Specified by:

deleteExistingAccountOrganizationHierarchy in interface BudgetConstructionDao

See Also:

BudgetConstructionDao.deleteExistingAccountOrganizationHierarchy(java.lang.Integer, java.lang.String, java.lang.String)

getDetailSalarySettingLaborObjects

public List<String> getDetailSalarySettingLaborObjects(Integer universityFiscalYear,
                                                       String chartOfAccountsCode)

Description copied from interface: BudgetConstructionDao

Returns a list of labor objects that are Salary Setting detail related

Specified by:

getDetailSalarySettingLaborObjects in interface BudgetConstructionDao

Returns:

See Also:

BudgetConstructionDao.getDetailSalarySettingLaborObjects(java.lang.Integer, java.lang.String)

getPBGLSalarySettingRows

public List getPBGLSalarySettingRows(String documentNumber,
                                     List salarySettingObjects)

Description copied from interface: BudgetConstructionDao

Returns a list of Pending Budget GL rows that are Salary Setting detail related, based on the set of salarySettingObjects passed in

Specified by:

getPBGLSalarySettingRows in interface BudgetConstructionDao

Returns:

See Also:

BudgetConstructionDao.getPBGLSalarySettingRows(java.lang.String, java.util.List)

getAllFundingForPosition

public List<PendingBudgetConstructionAppointmentFunding> getAllFundingForPosition(Integer universityFiscalYear,
                                                                                  String positionNumber)

Description copied from interface: BudgetConstructionDao

Retrieves all PendingBudgetConstructionAppointmentFunding records for the given position key.

Specified by:

getAllFundingForPosition in interface BudgetConstructionDao

Parameters:

universityFiscalYear - budget fiscal year, primary key field for position record

positionNumber - position number, primary key field for position record

Returns:

List of PendingBudgetConstructionAppointmentFunding objects

See Also:

BudgetConstructionDao.getAllFundingForPosition(java.lang.Integer, java.lang.String)

setKualiModuleService

public void setKualiModuleService(org.kuali.rice.kns.service.KualiModuleService kualiModuleService)

Sets the kualiModuleService attribute value.

Parameters:

kualiModuleService - The kualiModuleService to set.

getDataDictionaryService

public org.kuali.rice.kns.service.DataDictionaryService getDataDictionaryService()

Gets the dataDictionaryService attribute.

Returns:

Returns the dataDictionaryService.

setDataDictionaryService

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

Sets the dataDictionaryService attribute value.

Parameters:

dataDictionaryService - The dataDictionaryService to set.