1 /*
2 * Copyright 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.batch.service;
17
18 import java.util.Map;
19
20 import org.kuali.ole.gl.batch.BalanceForwardRuleHelper;
21
22
23 /**
24 * An interface declaring the methods that steps running year end services would need to use to close out activity of an ending
25 * fiscal year (though, note: OrganizationReversion, the other year end job, is not defined here).
26 */
27 public interface YearEndService {
28
29
30 /**
31 * The method responsible for creating origin entries that will forward qualifying encumbrances into the next fiscal year.
32 *
33 * @param originEntryGroup the origin entry group where generated origin entries should be saved
34 * @param jobParameters the parameters necessary to run this job: the fiscal year to close and the university date the job was
35 * run
36 * @param forwardEncumbrancesCounts the statistical counts generated by this job
37 */
38 public void forwardEncumbrances(String encumbranceForwardFileName, Map jobParameters, Map<String, Integer> counts);
39
40 /**
41 * Implementations of this method are responsible for generating origin entries to forward the balances of qualifying balances
42 * from the previous fiscal year
43 *
44 * @param balanceForwardsUnclosedPriorYearAccountGroup the origin entry group to save balance forwarding origin entries with
45 * open accounts
46 * @param balanceForwardsClosedPriorYearAccountGroup the origin entry group to save balance forwarding origin entries with
47 * closed accounts
48 * @param balanceForwardRuleHelper the BalanceForwardRuleHelper which holds the important state - the job parameters and
49 * statistics - for the job to run
50 */
51 public void forwardBalances(String balanceForwardsUnclosedFileName, String balanceForwardsclosedFileName, BalanceForwardRuleHelper balanceForwardRuleHelper);
52
53 /**
54 * This method is considered responsible for generating all of the origin entries that will close out nominal activity for a
55 * given fiscal year.
56 *
57 * @param nominalClosingOriginEntryGroup the origin entry group that nominal activity closing origin entries
58 * @param nominalClosingJobParameters the parameters needed by the job to run correctly: the current university date and the
59 * fiscal year to close
60 * @param nominalClosingCounts counts the Map of statistical counts generated by the process
61 */
62 public void closeNominalActivity(String nominalClosingFileName, Map nominalClosingJobParameters);
63
64 /**
65 * Logs all of the missing prior year accounts that balances and encumbrances processed by year end jobs would attempt to call
66 * on
67 *
68 * @param balanceFiscalYear the fiscal year to find balances encumbrances for
69 */
70 public void logAllMissingPriorYearAccounts(Integer fiscalYear);
71
72 /**
73 * Logs all of the missing sub fund groups that balances and encumbrances processed by the year end job would attempt to call on
74 *
75 * @param balanceFiscalYear the fiscal year to find balances and encumbrances for
76 */
77 public void logAllMissingSubFundGroups(Integer fiscalYear);
78 }