001    /*
002     * Copyright 2011 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     */
016    package org.kuali.kfs.gl.service;
017    
018    import org.kuali.kfs.gl.batch.CollectorBatch;
019    import org.kuali.kfs.gl.businessobject.OriginEntryGroup;
020    import org.kuali.kfs.gl.report.CollectorReportData;
021    import org.kuali.kfs.gl.service.impl.ScrubberStatus;
022    import org.kuali.rice.kns.service.DateTimeService;
023    
024    /**
025     * An interface declaring methods needed to run the scrubber
026     */
027    public interface ScrubberService {
028    
029        /**
030         * Nightly process to scrub incoming GL transactions before posting to GL tables
031         */
032        public void scrubEntries();
033    
034        /**
035         * Scrubs data read in by the Collector
036         * 
037         * @param batch the data read by the Collector
038         * @param collectorReportData statistics about 
039         * @param overrideOriginEntryService the implementation of origin entry service to use for this specific Collector scrub
040         * @param overrideOriginEntryGroupService the implementation of origin entry group service to use for this specific Collector scrub
041         * @return the status returned by the Scrubber
042         */
043        public void scrubCollectorBatch(ScrubberStatus scrubberStatus, CollectorBatch batch, CollectorReportData collectorReportData);
044        
045        /**
046         * This process will call the scrubber in a read only mode. It will scrub a single group, won't create any output in origin
047         * entry. It will create a the scrubber report
048         * @param group the origin entry group to scrub for report
049         * @param documentNumber the id of documents which generated origin entries that should be scrubbed
050         */
051        public void scrubGroupReportOnly(String fileName, String documentNumber);
052    
053        
054        public void performDemerger();
055    }