001/*
002 * Copyright 2005-2006 The Kuali Foundation
003 * 
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 * 
008 * http://www.opensource.org/licenses/ecl2.php
009 * 
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.ole.gl.service;
017
018import org.kuali.ole.gl.batch.CollectorBatch;
019import org.kuali.ole.gl.report.CollectorReportData;
020import org.kuali.ole.gl.service.impl.ScrubberStatus;
021
022/**
023 * An interface declaring methods needed to run the scrubber
024 */
025public interface ScrubberService {
026
027    /**
028     * Nightly process to scrub incoming GL transactions before posting to GL tables
029     */
030    public void scrubEntries();
031
032    /**
033     * Scrubs data read in by the Collector
034     * 
035     * @param batch the data read by the Collector
036     * @param collectorReportData statistics about 
037     * @param overrideOriginEntryService the implementation of origin entry service to use for this specific Collector scrub
038     * @param overrideOriginEntryGroupService the implementation of origin entry group service to use for this specific Collector scrub
039     * @return the status returned by the Scrubber
040     */
041    public void scrubCollectorBatch(ScrubberStatus scrubberStatus, CollectorBatch batch, CollectorReportData collectorReportData);
042    
043    /**
044     * This process will call the scrubber in a read only mode. It will scrub a single group, won't create any output in origin
045     * entry. It will create a the scrubber report
046     * @param group the origin entry group to scrub for report
047     * @param documentNumber the id of documents which generated origin entries that should be scrubbed
048     */
049    public void scrubGroupReportOnly(String fileName, String documentNumber);
050
051    
052    public void performDemerger();
053}