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

All Known Implementing Classes:

CollectorHelperServiceImpl

public interface CollectorHelperService

Provides methods for processing gl incoming batch files.

Method Summary

boolean	checkTrailerTotals(CollectorBatch batch, CollectorReportData collectorReportData) Reconciles the trailer total count and amount to the actual parsed contents.
boolean	loadCollectorFile(String fileName, CollectorReportData collectorReportData, List<CollectorScrubberStatus> collectorScrubberStatuses, BatchInputFileType collectorInputFileType, PrintStream originEntryOutputPs) Loads the file given by the filename, then performs the collector process: parse, validate, store, email.
boolean	performValidation(CollectorBatch batch) Validates the contents of a parsed file.

Method Detail

loadCollectorFile

boolean loadCollectorFile(String fileName,
                          CollectorReportData collectorReportData,
                          List<CollectorScrubberStatus> collectorScrubberStatuses,
                          BatchInputFileType collectorInputFileType,
                          PrintStream originEntryOutputPs)

Loads the file given by the filename, then performs the collector process: parse, validate, store, email.

Parameters:

fileName - - name of file to load (including path)

group - the group into which to persist the origin entries for the collector batch/file

collectorReportData - the object used to store all of the collector status information for reporting

collectorScrubberStatuses - if the collector scrubber is able to be invoked upon this collector batch, then the status info of the collector status run is added to the end of this list

the - output stream to which to store origin entries that properly pass validation

Returns:

boolean - true if load was successful, false if errors were encountered

performValidation

boolean performValidation(CollectorBatch batch)

Validates the contents of a parsed file.

Parameters:

batch - - batch to validate

Returns:

boolean - true if validation was OK, false if there were errors

checkTrailerTotals

boolean checkTrailerTotals(CollectorBatch batch,
                           CollectorReportData collectorReportData)

Reconciles the trailer total count and amount to the actual parsed contents.

Parameters:

batch - - batch to check trailer

collectorReportData - if running the actual collector batch process, should be the object representing the reporting data for the batch run. Otherwise, if running in the batch upload screen or in a manner in which reporting information is not needed, then null may be passed in

Returns:

boolean - true if trailer check was OK, false if totals did not match