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.module.bc.batch.service;
017    
018    import java.util.Map;
019    
020    /*
021     * this service intializes/updates the budget construction data used by the budget module to build a new budget for the coming
022     * fiscal year
023     */
024    public interface GenesisService {
025        /*
026         * these routines indicate which actions are allowed in genesis
027         */
028        public boolean BatchPositionSynchAllowed(Integer BaseYear);
029        
030        public boolean CSFUpdatesAllowed(Integer BaseYear);
031    
032        public boolean GLUpdatesAllowed(Integer BaseYear);
033        
034        public boolean IsBudgetConstructionInUpdateMode(Integer BaseYear);
035    
036        // this step clears out the database for genesis
037        public void clearDBForGenesis(Integer BaseYear);
038        
039        /*
040         * this step updates budget construction with new data from the sources after genesis has run
041         */
042       public void bCUpdateStep(Integer baseYear); 
043        
044        /*
045         * this step fetches the base fiscal year based on today's date
046         */
047        public Integer genesisFiscalYearFromToday();
048    
049        /*
050         *  this step runs genesis
051         */
052        public void genesisStep(Integer baseYear);
053        /*
054         *   look of accounts from the payroll (CSF) or GL that came into budget construction but are *not* in the budget construction accounting table.
055         *   this can be due to an oversight on the part of the chart manager, or to problems with the current year's budget control.
056         *   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.
057         *   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.
058         */
059        public Map verifyAccountsAreAccessible(Integer requestFiscalYear);
060    }