org.kuali.kfs.gl.batch.service
Interface YearEndService

All Known Implementing Classes:

YearEndServiceImpl

public interface YearEndService

An interface declaring the methods that steps running year end services would need to use to close out activity of an ending fiscal year (though, note: OrganizationReversion, the other year end job, is not defined here).

Method Summary

void	closeNominalActivity(String nominalClosingFileName, Map nominalClosingJobParameters) This method is considered responsible for generating all of the origin entries that will close out nominal activity for a given fiscal year.
void	forwardBalances(String balanceForwardsUnclosedFileName, String balanceForwardsclosedFileName, BalanceForwardRuleHelper balanceForwardRuleHelper) Implementations of this method are responsible for generating origin entries to forward the balances of qualifying balances from the previous fiscal year
void	forwardEncumbrances(String encumbranceForwardFileName, Map jobParameters, Map<String,Integer> counts) The method responsible for creating origin entries that will forward qualifying encumbrances into the next fiscal year.
void	logAllMissingPriorYearAccounts(Integer fiscalYear) Logs all of the missing prior year accounts that balances and encumbrances processed by year end jobs would attempt to call on
void	logAllMissingSubFundGroups(Integer fiscalYear) Logs all of the missing sub fund groups that balances and encumbrances processed by the year end job would attempt to call on

Method Detail

forwardEncumbrances

void forwardEncumbrances(String encumbranceForwardFileName,
                         Map jobParameters,
                         Map<String,Integer> counts)

The method responsible for creating origin entries that will forward qualifying encumbrances into the next fiscal year.

Parameters:

originEntryGroup - the origin entry group where generated origin entries should be saved

jobParameters - the parameters necessary to run this job: the fiscal year to close and the university date the job was run

forwardEncumbrancesCounts - the statistical counts generated by this job

forwardBalances

void forwardBalances(String balanceForwardsUnclosedFileName,
                     String balanceForwardsclosedFileName,
                     BalanceForwardRuleHelper balanceForwardRuleHelper)

Implementations of this method are responsible for generating origin entries to forward the balances of qualifying balances from the previous fiscal year

Parameters:

balanceForwardsUnclosedPriorYearAccountGroup - the origin entry group to save balance forwarding origin entries with open accounts

balanceForwardsClosedPriorYearAccountGroup - the origin entry group to save balance forwarding origin entries with closed accounts

balanceForwardRuleHelper - the BalanceForwardRuleHelper which holds the important state - the job parameters and statistics - for the job to run

closeNominalActivity

void closeNominalActivity(String nominalClosingFileName,
                          Map nominalClosingJobParameters)

This method is considered responsible for generating all of the origin entries that will close out nominal activity for a given fiscal year.

Parameters:

nominalClosingOriginEntryGroup - the origin entry group that nominal activity closing origin entries

nominalClosingJobParameters - the parameters needed by the job to run correctly: the current university date and the fiscal year to close

nominalClosingCounts - counts the Map of statistical counts generated by the process

logAllMissingPriorYearAccounts

void logAllMissingPriorYearAccounts(Integer fiscalYear)

Logs all of the missing prior year accounts that balances and encumbrances processed by year end jobs would attempt to call on

Parameters:

balanceFiscalYear - the fiscal year to find balances encumbrances for

logAllMissingSubFundGroups

void logAllMissingSubFundGroups(Integer fiscalYear)

Logs all of the missing sub fund groups that balances and encumbrances processed by the year end job would attempt to call on

Parameters:

balanceFiscalYear - the fiscal year to find balances and encumbrances for