org.kuali.kfs.module.bc.document.service
Interface OrganizationBCDocumentSearchService

All Known Implementing Classes:

OrganizationBCDocumentSearchServiceImpl

public interface OrganizationBCDocumentSearchService

This class defines methods an OrganizationBCDocumentSearchService must provide The OrganizationBCDocumentSearchService provides methods that build and clean the temporary tables used in the Organization Account (Budget Document) Selection lookups. It is assumed that the Organization Tree exists and that the user has selected at least one organization before deriving the list of budgeted accounts (Budget Documents).

Method Summary

int	buildAccountManagerDelegateList(String principalName, Integer universityFiscalYear) Builds temporary table with accounts that the given user is a manager or delegate for.
int	buildAccountSelectPullList(String principalName, Integer universityFiscalYear) This method populates BudgetConstructionAccountSelect with rows associated with a set of selected organizations in the Organization Tree for the user and where Budget Documents exist.
int	buildBudgetedAccountsAbovePointsOfView(String principalName, Integer universityFiscalYear, String chartOfAccountsCode, String organizationCode) Populates BudgetConstructionAccountSelect with accounts that are above the user's current point of view and returns the number of rows inserted (which equates to number of accounts above).
void	cleanAccountSelectPullList(String principalName, Integer universityFiscalYear) This method depopulates BudgetConstructionAccountSelect rows associated with the user.

Method Detail

buildAccountSelectPullList

int buildAccountSelectPullList(String principalName,
                               Integer universityFiscalYear)

This method populates BudgetConstructionAccountSelect with rows associated with a set of selected organizations in the Organization Tree for the user and where Budget Documents exist.

Parameters:

principalName -

universityFiscalYear -

buildBudgetedAccountsAbovePointsOfView

int buildBudgetedAccountsAbovePointsOfView(String principalName,
                                           Integer universityFiscalYear,
                                           String chartOfAccountsCode,
                                           String organizationCode)

Populates BudgetConstructionAccountSelect with accounts that are above the user's current point of view and returns the number of rows inserted (which equates to number of accounts above).

Parameters:

principalName - user who we are building the list for

universityFiscalYear - budget year for records to look at

chartOfAccountsCode - chart code of user's current point of view

organizationCode - organization code of user's current point of view

Returns:

int number of rows inserted

buildAccountManagerDelegateList

int buildAccountManagerDelegateList(String principalName,
                                    Integer universityFiscalYear)

Builds temporary table with accounts that the given user is a manager or delegate for. Returns the number of rows inserted.

Parameters:

principalName - manager or delegate universal identifier

universityFiscalYear - budget fiscal year

cleanAccountSelectPullList

void cleanAccountSelectPullList(String principalName,
                                Integer universityFiscalYear)

This method depopulates BudgetConstructionAccountSelect rows associated with the user.

Parameters:

principalName -

universityFiscalYear -