01: /*
02: * Copyright 2006-2007 The Kuali Foundation.
03: *
04: * Licensed under the Educational Community License, Version 1.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.opensource.org/licenses/ecl1.php
09: *
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.module.gl.service;
17:
18: import java.util.Map;
19:
20: import org.kuali.module.gl.bo.OriginEntryGroup;
21:
22: /**
23: * An interface declaring the methods needed to run the organization reversion process
24: */
25: public interface OrganizationReversionProcessService {
26:
27: /**
28: * Runs the Organization Reversion Year End Process for the end of a fiscal year (ie, a process that
29: * runs before the fiscal year end, and thus uses current account, etc.)
30: *
31: * @param outputGroup the origin entry group that this process should save entries to
32: * @param jobParameters the parameters used in the process
33: * @param organizationReversionCounts a Map of named statistics generated by running the process
34: */
35: public void organizationReversionProcessEndOfYear(
36: OriginEntryGroup outputGroup, Map jobParameters,
37: Map<String, Integer> organizationReversionCounts);
38:
39: /**
40: * Organization Reversion Year End Process for the beginning of a fiscal year (ie, the process as it runs
41: * after the fiscal year end, thus using prior year account, etc.)
42: *
43: * @param outputGroup the origin entry group that this process should save entries to
44: * @param jobParameters the parameters used in the process
45: * @param organizationReversionCounts a Map of named statistics generated by running the process
46: */
47: public void organizationReversionProcessBeginningOfYear(
48: OriginEntryGroup outputGroup, Map jobParameters,
49: Map<String, Integer> organizationReversionCounts);
50:
51: /**
52: * Generates reports for a run of the organization reversion process
53: *
54: * @param outputGroup the origin entry group holding the origin entries created by the run
55: * @param jobParameters the parameters used during the run
56: * @param organizationReversionCounts the statistical counts generated by the run of the organization reversion process
57: */
58: public void generateOrganizationReversionProcessReports(
59: OriginEntryGroup outputGroup, Map jobParameters,
60: Map<String, Integer> organizationReversionCounts);
61:
62: /**
63: * Returns the parameters for this organization reversion job
64: *
65: * @return a Map of standard parameters for the job
66: */
67: public Map getJobParameters();
68:
69: /**
70: * Creates an origin entry group for this run of the organization reversion process
71: *
72: * @return a properly initialized origin entry group
73: */
74: public OriginEntryGroup createOrganizationReversionProcessOriginEntryGroup();
75: }
|