org.kuali.kfs.module.bc.document.dataaccess
Interface BudgetConstructionDao

All Known Implementing Classes:

BudgetConstructionDaoOjb

public interface BudgetConstructionDao

This interface defines the methods that a BudgetConstructionDao must provide.

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
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 currentLevel, 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 chartCd, String accountNbr, 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

Method Detail

getByCandidateKey

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

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

Parameters:

chartOfAccountsCode -

accountNumber -

subAccountNumber -

fiscalYear -

Returns:

BudgetConstructionHeader

saveBudgetConstructionHeader

void saveBudgetConstructionHeader(BudgetConstructionHeader bcHeader)

This saves a BudgetConstructionHeader object to the database

Parameters:

bcHeader -

saveBudgetConstructionDocument

void saveBudgetConstructionDocument(BudgetConstructionDocument bcDocument)

Save a BudgetConstructionDocument object to the database

Parameters:

bcDocument -

getByPrimaryId

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

Parameters:

chartOfAccountsCode -

accountNumber -

subAccountNumber -

fiscalYear -

principalId -

Returns:

BudgetConstructionFundingLock

saveBudgetConstructionFundingLock

void saveBudgetConstructionFundingLock(BudgetConstructionFundingLock budgetConstructionFundingLock)

This saves a BudgetConstructionFundingLock to the database

Parameters:

budgetConstructionFundingLock -

deleteBudgetConstructionFundingLock

void deleteBudgetConstructionFundingLock(BudgetConstructionFundingLock budgetConstructionFundingLock)

This deletes a BudgetConstructionFundingLock from the database

Parameters:

budgetConstructionFundingLock -

getFlocksForAccount

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.

Parameters:

chartOfAccountsCode -

accountNumber -

subAccountNumber -

fiscalYear -

Returns:

Collection

getPositionAssociatedWithFundingLock

String getPositionAssociatedWithFundingLock(BudgetConstructionFundingLock budgetConstructionFundingLock)

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

Parameters:

budgetConstructionFundingLock - - funding lock to get position for

Returns:

position number associated with lock

getByPrimaryId

BudgetConstructionPosition getByPrimaryId(String positionNumber,
                                          Integer fiscalYear)

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

Parameters:

positionNumber -

fiscalYear -

Returns:

BudgetConstructionPosition

saveBudgetConstructionPosition

void saveBudgetConstructionPosition(BudgetConstructionPosition bcPosition)

Saves a BudgetConstructionPosition to the database

Parameters:

bcPosition -

deleteBudgetConstructionPullupByUserId

void deleteBudgetConstructionPullupByUserId(String principalName)

This method deletes all BudgetConstructionPullup rows associated with a user.

Parameters:

principalName -

getBudgetConstructionPullupFlagSetByUserId

List<BudgetConstructionPullup> getBudgetConstructionPullupFlagSetByUserId(String principalName)

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

Parameters:

principalName -

Returns:

getBudgetConstructionPullupChildOrgs

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

Parameters:

principalId -

chartOfAccountsCode -

organizationCode -

Returns:

getPendingBudgetConstructionAppointmentFundingRequestSum

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

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

Parameters:

salaryDetailLine -

Returns:

getDocumentPBGLFringeLines

List getDocumentPBGLFringeLines(String documentNumber,
                                List fringeObjects)

returns a list of fringe benefit accounting lines for a document

Parameters:

documentNumber -

fringeObjects -

Returns:

isDelegate

boolean isDelegate(String chartCd,
                   String accountNbr,
                   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

Parameters:

chartCd -

accountNbr -

principalId -

Returns:

getAccountOrgHierForAccount

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

Returns a list of account organization hierarchy levels for an account

Parameters:

chartOfAccountsCode -

accountNumber -

universityFiscalYear -

Returns:

getDetailSalarySettingLaborObjects

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

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

Parameters:

universityFiscalYear -

chartOfAccountsCode -

Returns:

getPBGLSalarySettingRows

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

Parameters:

documentNumber -

salarySettingObjects -

Returns:

getAllFundingForPosition

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

Retrieves all PendingBudgetConstructionAppointmentFunding records for the given position key.

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

getAccountReports

BudgetConstructionAccountReports getAccountReports(String chartOfAccountsCode,
                                                   String accountNumber)

Returns a BudgetConstructionAccountReports object for the given key.

Parameters:

chartOfAccountsCode -

accountNumber -

Returns:

getOrganizationReports

BudgetConstructionOrganizationReports getOrganizationReports(String chartOfAccountsCode,
                                                             String organizationCode)

Returns a BudgetConstructionOrganizationReports object for the given key.

Parameters:

chartOfAccountsCode -

organizationCode -

Returns:

insertAccountIntoAccountOrganizationHierarchy

boolean insertAccountIntoAccountOrganizationHierarchy(String rootChart,
                                                      String rootOrganization,
                                                      Integer universityFiscalYear,
                                                      String chartOfAccountsCode,
                                                      String accountNumber,
                                                      Integer currentLevel,
                                                      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.

Parameters:

rootChart -

rootOrganization -

universityFiscalYear -

chartOfAccountsCode -

accountNumber -

currentLevel -

organizationChartOfAccountsCode -

organizationCode -

Returns:

deleteExistingAccountOrganizationHierarchy

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

Parameters:

universityFiscalYear -

chartOfAccountsCode -

accountNumber -