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

All Known Implementing Classes:

CollectorScrubberServiceImpl

public interface CollectorScrubberService

An interface declaring the methods needed to scrub Collector data

Method Summary

void	removeTempGroups(Collection<CollectorScrubberStatus> allStatusObjectsFromCollectorExecution) Removes any temporarily created origin entries and origin entry groups so that they won't be persisted after the transaction is committed.
CollectorScrubberStatus	scrub(CollectorBatch batch, CollectorReportData collectorReportData, String collectorFileDirectoryName) Runs the scrubber on the origin entries in the batch.

Method Detail

scrub

CollectorScrubberStatus scrub(CollectorBatch batch,
                              CollectorReportData collectorReportData,
                              String collectorFileDirectoryName)

Runs the scrubber on the origin entries in the batch. Any OEs edits/removals result of the scrub and demerger are removed from the batch, and the same changes are reflected in the details in the same batch.

Parameters:

batch - the data read in by the Collector

collectorReportData - statistics generated by the scrub run on the Collector data

Returns:

an object with the collector scrubber status. Note that it contains references to at least 4 origin entry groups, and the origin entry group service and origin entry service under which these groups and their entries are stored. The groups and their entries are created to facilitate the scrub and reporting processes, and they should not be persisted after the collector finishes running. Therefore, an collection of all CollectorScrubberStatus objects returned in a single collector execution (i.e. from a nightly job) must be passed into a parameter to the removeTempGroups(Collection) method.. The service definitions are needed because the collector may choose to store temporary origin entries and origin entry groups in another service segregated from the database.

removeTempGroups

void removeTempGroups(Collection<CollectorScrubberStatus> allStatusObjectsFromCollectorExecution)

Removes any temporarily created origin entries and origin entry groups so that they won't be persisted after the transaction is committed.

Parameters:

allStatusObjectsFromCollectorExecution - a Collection of ScrubberStatus records to help find bad Collector data