View Javadoc
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.gl.batch;
20  
21  import java.util.Date;
22  
23  import org.kuali.kfs.gl.service.OriginEntryGroupService;
24  import org.kuali.kfs.sys.batch.AbstractStep;
25  import org.kuali.kfs.sys.batch.TestingStep;
26  
27  /**
28   * This step will mark all backup groups in the database so that they will not be scrubbed when the nightly scrubber step runs
29   * again.
30   */
31  public class MarkScrubbableBackupGroupsAsUnscrubbableStep extends AbstractStep implements TestingStep {
32      private OriginEntryGroupService originEntryGroupService;
33  
34      /**
35       * Marks all scrubbable backup groups as unscrubbable
36       * 
37       * @param jobName the name of the job this step is being run as part of
38       * @param jobRunDate the time/date the job is being run
39       * @return true if the step completed successfully, false if otherwise
40       * @see org.kuali.kfs.sys.batch.Step#execute(java.lang.String)
41       */
42      public boolean execute(String jobName, Date jobRunDate) throws InterruptedException {
43          //TODO:- This step is not running. 
44          //originEntryGroupService.markScrubbableBackupGroupsAsUnscrubbable();
45          return true;
46      }
47  
48      /**
49       * Sets the originEntryGroupSerivce, allowing the injection of an implementation of that service
50       * 
51       * @param originEntryGroupService an implementation originEntryGroupService to set
52       * @see org.kuali.kfs.gl.service.OriginEntryGroupService
53       */
54      public void setOriginEntryGroupService(OriginEntryGroupService originEntryGroupService) {
55          this.originEntryGroupService = originEntryGroupService;
56      }
57  }