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.gl.batch;
017    
018    import java.util.Date;
019    
020    import org.kuali.kfs.gl.service.OriginEntryGroupService;
021    import org.kuali.kfs.sys.batch.AbstractStep;
022    import org.kuali.kfs.sys.batch.TestingStep;
023    
024    /**
025     * This step will mark all backup groups in the database so that they will not be scrubbed when the nightly scrubber step runs
026     * again.
027     */
028    public class MarkScrubbableBackupGroupsAsUnscrubbableStep extends AbstractStep implements TestingStep {
029        private OriginEntryGroupService originEntryGroupService;
030    
031        /**
032         * Marks all scrubbable backup groups as unscrubbable
033         * 
034         * @param jobName the name of the job this step is being run as part of
035         * @param jobRunDate the time/date the job is being run
036         * @return true if the step completed successfully, false if otherwise
037         * @see org.kuali.kfs.sys.batch.Step#execute(java.lang.String)
038         */
039        public boolean execute(String jobName, Date jobRunDate) throws InterruptedException {
040            //TODO:- This step is not running. 
041            //originEntryGroupService.markScrubbableBackupGroupsAsUnscrubbable();
042            return true;
043        }
044    
045        /**
046         * Sets the originEntryGroupSerivce, allowing the injection of an implementation of that service
047         * 
048         * @param originEntryGroupService an implementation originEntryGroupService to set
049         * @see org.kuali.kfs.gl.service.OriginEntryGroupService
050         */
051        public void setOriginEntryGroupService(OriginEntryGroupService originEntryGroupService) {
052            this.originEntryGroupService = originEntryGroupService;
053        }
054    }