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

All Known Implementing Classes:

OrganizationReversionProcessImpl

public interface OrganizationReversionProcess

Method Summary

void	calculateTotals() This method calculates the totals for a given unit of work's reversion
void	generateCarryForwards(List<OriginEntryFull> originEntriesToWrite) If carry forwards need to be generated for this unit of work, this method will generate the origin entries to accomplish those object codes.
void	generateCashReversions(List<OriginEntryFull> originEntriesToWrite) This method generates cash reversion origin entries for the current organization reversion, and adds them to the given list
void	generateMany(List<OriginEntryFull> originEntriesToWrite) Generates carry forward origin entries on a category by category basis (if the organization reversion record asks for that), assuming carry forwards are required for the current unit of work
List<OriginEntryFull>	generateOutputOriginEntries() This method determines which origin entries (reversion, cash reversion, or carry forward) need to be generated for the current unit of work, and then delegates to the origin entry generation methods to create those entries
void	generateReversions(List<OriginEntryFull> originEntriesToWrite) If reversions are necessary, this will generate the origin entries for those reversions
int	getBalancesRead() Returns the total number of balances for the previous fiscal year
int	getBalancesSelected() Returns the total number of balances selected for inclusion in this process
List<OriginEntryFull>	getGeneratedOriginEntries() Gets the generatedOriginEntries attribute.
void	initializeProcess() This method initializes several properties needed for the process to run correctly
void	organizationReversionProcess(Map jobParameters, Map<String,Integer> organizationReversionCounts) Runs the organization reversion process.
void	processBalances(Iterator<Balance> balances) Given a list of balances, this method generates the origin entries for the organization reversion/carry forward process, and saves those to an initialized origin entry group
void	setHoldGeneratedOriginEntries(boolean holdGeneratedOriginEntries) Sets the holdGeneratedOriginEntries attribute value.
void	writeLedgerSummaryReport(ReportWriterService reportWriterService) Writes out the encapsulated origin entry ledger report to the given reportWriterService

Method Detail

organizationReversionProcess

void organizationReversionProcess(Map jobParameters,
                                  Map<String,Integer> organizationReversionCounts)

Runs the organization reversion process.

Parameters:

jobParameters - the parameters used in the process

organizationReversionCounts - a Map of named statistics generated by running the process

initializeProcess

void initializeProcess()

This method initializes several properties needed for the process to run correctly

processBalances

void processBalances(Iterator<Balance> balances)

Given a list of balances, this method generates the origin entries for the organization reversion/carry forward process, and saves those to an initialized origin entry group

Parameters:

balances - an iterator of balances to process; each balance returned by the iterator will be processed by this method

generateOutputOriginEntries

List<OriginEntryFull> generateOutputOriginEntries()
                                                  throws FatalErrorException

This method determines which origin entries (reversion, cash reversion, or carry forward) need to be generated for the current unit of work, and then delegates to the origin entry generation methods to create those entries

Returns:

a list of OriginEntries which need to be written

Throws:

FatalErrorException - thrown if object codes are missing in any of the generation methods

generateCashReversions

void generateCashReversions(List<OriginEntryFull> originEntriesToWrite)
                            throws FatalErrorException

This method generates cash reversion origin entries for the current organization reversion, and adds them to the given list

Parameters:

originEntriesToWrite - a list of OriginEntryFulls to stick generated origin entries into

Throws:

FatalErrorException - thrown if an origin entry's object code can't be found

generateMany

void generateMany(List<OriginEntryFull> originEntriesToWrite)
                  throws FatalErrorException

Generates carry forward origin entries on a category by category basis (if the organization reversion record asks for that), assuming carry forwards are required for the current unit of work

Parameters:

originEntriesToWrite - a list of origin entries to write, which any generated origin entries should be added to

Throws:

FatalErrorException - thrown if an object code cannot be found

generateCarryForwards

void generateCarryForwards(List<OriginEntryFull> originEntriesToWrite)
                           throws FatalErrorException

If carry forwards need to be generated for this unit of work, this method will generate the origin entries to accomplish those object codes. Note: this will only be called if the organization reversion record tells the process to munge all carry forwards for all categories together; if the organization reversion record does not call for such a thing, then generateMany will be called

Parameters:

originEntriesToWrite - a list of origin entries to write, that any generated origin entries should be added to

Throws:

FatalErrorException - thrown if the current object code can't be found in the database

generateReversions

void generateReversions(List<OriginEntryFull> originEntriesToWrite)
                        throws FatalErrorException

If reversions are necessary, this will generate the origin entries for those reversions

Parameters:

originEntriesToWrite - the list of origin entries to add reversions into

Throws:

FatalErrorException - thrown if object code if the entry can't be found

calculateTotals

void calculateTotals()
                     throws FatalErrorException

This method calculates the totals for a given unit of work's reversion

Throws:

FatalErrorException

writeLedgerSummaryReport

void writeLedgerSummaryReport(ReportWriterService reportWriterService)

Writes out the encapsulated origin entry ledger report to the given reportWriterService

Parameters:

reportWriterService - the report to write the ledger summary report to

setHoldGeneratedOriginEntries

void setHoldGeneratedOriginEntries(boolean holdGeneratedOriginEntries)

Sets the holdGeneratedOriginEntries attribute value.

Parameters:

holdGeneratedOriginEntries - The holdGeneratedOriginEntries to set.

getGeneratedOriginEntries

List<OriginEntryFull> getGeneratedOriginEntries()

Gets the generatedOriginEntries attribute.

Returns:

Returns the generatedOriginEntries.

getBalancesRead

int getBalancesRead()

Returns the total number of balances for the previous fiscal year

Returns:

the total number of balances for the previous fiscal year

getBalancesSelected

int getBalancesSelected()

Returns the total number of balances selected for inclusion in this process

Returns:

the total number of balances selected for inclusion in this process