1 /*
2 * Copyright 2005-2006 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.ole.gl.service;
17
18 import org.kuali.ole.gl.batch.CollectorBatch;
19 import org.kuali.ole.gl.report.CollectorReportData;
20 import org.kuali.ole.gl.service.impl.ScrubberStatus;
21
22 /**
23 * An interface declaring methods needed to run the scrubber
24 */
25 public interface ScrubberService {
26
27 /**
28 * Nightly process to scrub incoming GL transactions before posting to GL tables
29 */
30 public void scrubEntries();
31
32 /**
33 * Scrubs data read in by the Collector
34 *
35 * @param batch the data read by the Collector
36 * @param collectorReportData statistics about
37 * @param overrideOriginEntryService the implementation of origin entry service to use for this specific Collector scrub
38 * @param overrideOriginEntryGroupService the implementation of origin entry group service to use for this specific Collector scrub
39 * @return the status returned by the Scrubber
40 */
41 public void scrubCollectorBatch(ScrubberStatus scrubberStatus, CollectorBatch batch, CollectorReportData collectorReportData);
42
43 /**
44 * This process will call the scrubber in a read only mode. It will scrub a single group, won't create any output in origin
45 * entry. It will create a the scrubber report
46 * @param group the origin entry group to scrub for report
47 * @param documentNumber the id of documents which generated origin entries that should be scrubbed
48 */
49 public void scrubGroupReportOnly(String fileName, String documentNumber);
50
51
52 public void performDemerger();
53 }