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.sys.batch.service;
017    
018    import org.kuali.kfs.sys.batch.dataaccess.FiscalYearMakersDao;
019    
020    /**
021     * Runs the fiscal year maker process which creates rows for the next fiscal year based on records for the current fiscal year for
022     * configured tables. The base year for the process is given by the system parameter
023     * <code>KFS-COA FiscalYearMakerStep SOURCE_FISCAL_YEAR</code>. In addition, the process has an option for how it should handle
024     * records that already exist in the target year. If the system parameter
025     * <code>KFS-COA FiscalYearMakerStep OVERRIDE_TARGET_YEAR_DATA_IND</code> is set to 'Y', target year records will be overwritten;
026     * Otherwise, target year records that already exist will be left alone. Each table that is setup for the fiscal year maker process
027     * has a bean configured in Spring. This bean points to an implementation of <code>FiscalYearMaker</code> (either the default
028     * implementation or custom) that sets up the <code>Criteria</code> for selecting records to copy, and performs the process of
029     * changing the records for the new year. New implementations can be created and configured in Spring to customize the behavior for
030     * a table.
031     */
032    public interface FiscalYearMakerService {
033    
034        /**
035         * Runs the fiscal year maker process for the configured base year
036         */
037        public void runProcess();
038    }