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

All Known Implementing Classes:

ScrubberProcessImpl

public interface ScrubberProcess

Method Summary

Date	calculateRunDate(Date currentDate) This method modifies the run date if it is before the cutoff time specified by the RunTimeService See KULRNE-70 This method is public to facilitate unit testing
void	performDemerger() The demerger process reads all of the documents in the error group, then moves all of the original entries for that document from the valid group to the error group.
void	scrubCollectorBatch(ScrubberStatus scrubberStatus, CollectorBatch batch, CollectorReportData collectorReportData) Scrubs the origin entry and ID billing details if the given batch.
void	scrubEntries() Scrubs all entries in all groups and documents.
void	scrubEntries(boolean reportOnlyMode, String documentNumber) Scrub all entries that need it in origin entry.
void	scrubGroupReportOnly(String fileName, String documentNumber) Scrub this single group read only.
void	setCostShareObjectCode(OriginEntryFull costShareEntry, OriginEntryInformation originEntry) Sets the proper cost share object code in an entry and its offset

Method Detail

scrubGroupReportOnly

void scrubGroupReportOnly(String fileName,
                          String documentNumber)

Scrub this single group read only. This will only output the scrubber report. It won't output any other groups.

Parameters:

group - the origin entry group that should be scrubbed

the - document number of any specific entries to scrub

scrubEntries

void scrubEntries()

Scrubs all entries in all groups and documents.

scrubCollectorBatch

void scrubCollectorBatch(ScrubberStatus scrubberStatus,
                         CollectorBatch batch,
                         CollectorReportData collectorReportData)

Scrubs the origin entry and ID billing details if the given batch. Store all scrubber output into the collectorReportData parameter. NOTE: DO NOT CALL ANY OF THE scrub* METHODS OF THIS CLASS AFTER CALLING THIS METHOD FOR EVERY UNIQUE INSTANCE OF THIS CLASS, OR THE COLLECTOR REPORTS MAY BE CORRUPTED

Parameters:

batch - the data gathered from a Collector file

collectorReportData - the statistics generated by running the Collector

scrubEntries

void scrubEntries(boolean reportOnlyMode,
                  String documentNumber)

Scrub all entries that need it in origin entry. Put valid scrubbed entries in a scrubber valid group, put errors in a scrubber error group, and transactions with an expired account in the scrubber expired account group.

Parameters:

group - the specific origin entry group to scrub

documentNumber - the number of the document with entries to scrub

performDemerger

void performDemerger()

The demerger process reads all of the documents in the error group, then moves all of the original entries for that document from the valid group to the error group. It does not move generated entries to the error group. Those are deleted. It also modifies the doc number and origin code of cost share transfers.

Parameters:

errorGroup - this scrubber run's error group

validGroup - this scrubber run's valid group

setCostShareObjectCode

void setCostShareObjectCode(OriginEntryFull costShareEntry,
                            OriginEntryInformation originEntry)

Sets the proper cost share object code in an entry and its offset

Parameters:

costShareEntry - GL Entry for cost share

originEntry - Scrubbed GL Entry that this is based on

calculateRunDate

Date calculateRunDate(Date currentDate)

This method modifies the run date if it is before the cutoff time specified by the RunTimeService See KULRNE-70 This method is public to facilitate unit testing

Parameters:

currentDate - the date the scrubber should report as having run on

Returns:

the run date