1 /*
2 * The Kuali Financial System, a comprehensive financial management system for higher education.
3 *
4 * Copyright 2005-2014 The Kuali Foundation
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as
8 * published by the Free Software Foundation, either version 3 of the
9 * License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
15 *
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19 package org.kuali.kfs.module.bc.batch.service;
20
21 import java.util.Map;
22
23 /*
24 * this service intializes/updates the budget construction data used by the budget module to build a new budget for the coming
25 * fiscal year
26 */
27 public interface GenesisService {
28 /*
29 * these routines indicate which actions are allowed in genesis
30 */
31 public boolean BatchPositionSynchAllowed(Integer BaseYear);
32
33 public boolean CSFUpdatesAllowed(Integer BaseYear);
34
35 public boolean GLUpdatesAllowed(Integer BaseYear);
36
37 public boolean IsBudgetConstructionInUpdateMode(Integer BaseYear);
38
39 // this step clears out the database for genesis
40 public void clearDBForGenesis(Integer BaseYear);
41
42 /*
43 * this step updates budget construction with new data from the sources after genesis has run
44 */
45 public void bCUpdateStep(Integer baseYear);
46
47 /*
48 * this step fetches the base fiscal year based on today's date
49 */
50 public Integer genesisFiscalYearFromToday();
51
52 /*
53 * this step runs genesis
54 */
55 public void genesisStep(Integer baseYear);
56 /*
57 * look of accounts from the payroll (CSF) or GL that came into budget construction but are *not* in the budget construction accounting table.
58 * this can be due to an oversight on the part of the chart manager, or to problems with the current year's budget control.
59 * such accounts will not appear in the pull-up list, since they can't be added to the reporting hierarchy, which is built from budget construction accounting.
60 * this method is provided for use by a report an institution might want to write. such accounts will always appear in the log from bCUpdateStep above, whether this method is used or not.
61 */
62 public Map verifyAccountsAreAccessible(Integer requestFiscalYear);
63 }