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

All Known Implementing Classes:

BudgetPushPullServiceImpl

public interface BudgetPushPullService

This interface defines the methods that perform Pullup or Pushdown operations on Budget Construction Documents.

Method Summary

int	buildPullUpBudgetedDocuments(String principalId, Integer FiscalYear, String pointOfViewCharOfAccountsCode, String pointOfViewOrganizationCode) Builds list of budget documents that are in the selected organizations and above the user's point of view.
int	buildPushDownBudgetedDocuments(String principalId, Integer FiscalYear, String pointOfViewCharOfAccountsCode, String pointOfViewOrganizationCode) Builds list of budget documents that are in the selected organizations and at the user's point of view.
void	pullupSelectedOrganizationDocuments(String principalId, Integer FiscalYear, String pointOfViewCharOfAccountsCode, String pointOfViewOrganizationCode) Pulls up Budget Construction documents based on user selected Organizations and the current point of view Organization on the Organization Selection screen running in Pullup mode.
void	pushdownSelectedOrganizationDocuments(String principalId, Integer FiscalYear, String pointOfViewCharOfAccountsCode, String pointOfViewOrganizationCode) Pushes down Budget Construction documents based on user selected Organizations and the current point of view Organization on the Organization Selection screen running in Pushdown mode.

Method Detail

pullupSelectedOrganizationDocuments

void pullupSelectedOrganizationDocuments(String principalId,
                                         Integer FiscalYear,
                                         String pointOfViewCharOfAccountsCode,
                                         String pointOfViewOrganizationCode)

Pulls up Budget Construction documents based on user selected Organizations and the current point of view Organization on the Organization Selection screen running in Pullup mode.

Parameters:

principalId -

FiscalYear -

pointOfViewCharOfAccountsCode -

pointOfViewOrganizationCode -

pushdownSelectedOrganizationDocuments

void pushdownSelectedOrganizationDocuments(String principalId,
                                           Integer FiscalYear,
                                           String pointOfViewCharOfAccountsCode,
                                           String pointOfViewOrganizationCode)

Pushes down Budget Construction documents based on user selected Organizations and the current point of view Organization on the Organization Selection screen running in Pushdown mode.

Parameters:

principalId -

FiscalYear -

pointOfViewCharOfAccountsCode -

pointOfViewOrganizationCode -

buildPullUpBudgetedDocuments

int buildPullUpBudgetedDocuments(String principalId,
                                 Integer FiscalYear,
                                 String pointOfViewCharOfAccountsCode,
                                 String pointOfViewOrganizationCode)

Builds list of budget documents that are in the selected organizations and above the user's point of view. Called from the Org Pull Up screen to display the documents that will be affected by the pull up.

Parameters:

principalId - current user doing the pullup

FiscalYear - budget fiscal year

pointOfViewCharOfAccountsCode - user's point of view chart

pointOfViewOrganizationCode - user's point of view org

Returns:

int number of rows affected (number of documents)

buildPushDownBudgetedDocuments

int buildPushDownBudgetedDocuments(String principalId,
                                   Integer FiscalYear,
                                   String pointOfViewCharOfAccountsCode,
                                   String pointOfViewOrganizationCode)

Builds list of budget documents that are in the selected organizations and at the user's point of view. Called from the Org Push Down screen to display the documents that will be affected by the push down.

Parameters:

principalId - current user doing the pushdown

FiscalYear - budget fiscal year

pointOfViewCharOfAccountsCode - user's point of view chart

pointOfViewOrganizationCode - user's point of view org

Returns:

int number of rows affected (number of documents)