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

All Known Implementing Classes:

BalancingServiceBaseImpl, BalancingServiceImpl, LaborBalancingServiceImpl

public interface BalancingService

Interface for BalancingService

Method Summary

void	clearHistories() Removes the data from the History tables.
void	clearPosterFileCache() In order to avoid file system scans this class caches poster input and poster error filenames.
Balance	getBalance(LedgerBalanceHistory ledgerBalanceHistory) Returns a Balance object for the parameters of the passed in LedgerBalanceHistory.
int	getComparisonFailuresToPrintPerReport()
File	getICRErrorOutputFile()
File	getICRInputFile()
OriginEntryInformation	getOriginEntry(String inputLine, int lineNumber) Gets an OriginEntryInformation for the parsed line.
int	getPastFiscalYearsToConsider()
File	getPosterErrorOutputFile()
File	getPosterInputFile()
File	getReversalErrorOutputFile()
File	getReversalInputFile()
String	getShortTableLabel(String businessObjectName)
boolean	runBalancing() Handle for batch processes to kick off balancing
void	updateBalanceHistory(Integer postMode, OriginEntryInformation originEntry) Updates the balance history table
void	updateEntryHistory(Integer postMode, OriginEntryInformation originEntry) Update the entry history table

Method Detail

runBalancing

boolean runBalancing()

Handle for batch processes to kick off balancing

Returns:

boolean true when success

getPosterInputFile

File getPosterInputFile()

Returns:

input poster file. Returns null if no file found.

getPosterErrorOutputFile

File getPosterErrorOutputFile()

Returns:

output poster error file. Returns null if no file found.

getReversalInputFile

File getReversalInputFile()

Returns:

input reversal file. Returns null if no file found.

getReversalErrorOutputFile

File getReversalErrorOutputFile()

Returns:

output reversal error file. Returns null if no file found.

getICRInputFile

File getICRInputFile()

Returns:

input ICR file. Returns null if no file found.

getICRErrorOutputFile

File getICRErrorOutputFile()

Returns:

output ICR error file. Returns null if no file found.

getPastFiscalYearsToConsider

int getPastFiscalYearsToConsider()

Returns:

system parameter for NUMBER_OF_PAST_FISCAL_YEARS_TO_CONSIDER

getComparisonFailuresToPrintPerReport

int getComparisonFailuresToPrintPerReport()

Returns:

system parameter for NUMBER_OF_COMPARISON_FAILURES_TO_PRINT_PER_REPORT

getShortTableLabel

String getShortTableLabel(String businessObjectName)

Parameters:

businessObjectName - name of the BO for which to return the label

Returns:

functional short labels for tables affected in this process

getOriginEntry

OriginEntryInformation getOriginEntry(String inputLine,
                                      int lineNumber)

Gets an OriginEntryInformation for the parsed line. This needs to be handled separately for GL and Labor because Labor is a special case of GL (positionNumber + emplid). Could be done with an OriginEntryHistory interface but in the interest of not mucking with OriginEntries the is done with delegation.

Parameters:

inputLine - line that was read from getPosterInputFilename

lineNumber - line number we are currently reading from getPosterInputFilename

Returns:

parsed line into an object as per inputLine parameter

updateEntryHistory

void updateEntryHistory(Integer postMode,
                        OriginEntryInformation originEntry)

Update the entry history table

Parameters:

mode - of post, e.g. MODE_REVERSAL

originEntry - representing the update details

updateBalanceHistory

void updateBalanceHistory(Integer postMode,
                          OriginEntryInformation originEntry)

Updates the balance history table

Parameters:

originEntry - representing the update details

getBalance

Balance getBalance(LedgerBalanceHistory ledgerBalanceHistory)

Returns a Balance object for the parameters of the passed in LedgerBalanceHistory. Necessary for generic amount comparision since it may be either labor or gl.

Parameters:

ledgerBalanceHistory - to retrieve the Balance object for

Returns:

balance object adhereing to the Balance interface

clearPosterFileCache

void clearPosterFileCache()

In order to avoid file system scans this class caches poster input and poster error filenames. In rare cases they may want to be reset.

clearHistories

void clearHistories()

Removes the data from the History tables.