View Javadoc
1   /*
2    * Copyright 2008-2009 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.sys.batch.service;
17  
18  
19  /**
20   * Runs the fiscal year maker process which creates rows for the next fiscal year based on records for the current fiscal year for
21   * configured tables. The base year for the process is given by the system parameter
22   * <code>OLE-COA FiscalYearMakerStep SOURCE_FISCAL_YEAR</code>. In addition, the process has an option for how it should handle
23   * records that already exist in the target year. If the system parameter
24   * <code>OLE-COA FiscalYearMakerStep OVERRIDE_TARGET_YEAR_DATA_IND</code> is set to 'Y', target year records will be overwritten;
25   * Otherwise, target year records that already exist will be left alone. Each table that is setup for the fiscal year maker process
26   * has a bean configured in Spring. This bean points to an implementation of <code>FiscalYearMaker</code> (either the default
27   * implementation or custom) that sets up the <code>Criteria</code> for selecting records to copy, and performs the process of
28   * changing the records for the new year. New implementations can be created and configured in Spring to customize the behavior for
29   * a table.
30   */
31  public interface FiscalYearMakerService {
32  
33      /**
34       * Runs the fiscal year maker process for the configured base year
35       */
36      public void runProcess();
37  }