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.ExpenditureTransactionService;
021    import org.kuali.kfs.sys.batch.AbstractStep;
022    import org.kuali.kfs.sys.batch.TestingStep;
023    
024    /**
025     * A step to remove all expenditure transactions held in the database
026     */
027    public class DeleteAllExpenditureTransactionsStep extends AbstractStep implements TestingStep {
028        private ExpenditureTransactionService expenditureTransactionService;
029    
030        /**
031         * Runs the process of deleting all expenditure transactions
032         * 
033         * @param jobName the name of the job this step is being run as part of
034         * @param jobRunDate the time/date when the job was started
035         * @return true if the job finished successfully, false if otherwise
036         * @see org.kuali.kfs.sys.batch.Step#execute(java.lang.String)
037         */
038        public boolean execute(String jobName, Date jobRunDate) throws InterruptedException {
039            expenditureTransactionService.deleteAllExpenditureTransactions();
040            return true;
041        }
042    
043        /**
044         * Sets the expenditureTransactionService attribute, allowing the inject of an implementation of this service
045         * 
046         * @param expenditureTransactionService
047         * @see org.kuali.kfs.gl.service.ExpenditureTransactionService
048         */
049        public void setExpenditureTransactionService(ExpenditureTransactionService expenditureTransactionService) {
050            this.expenditureTransactionService = expenditureTransactionService;
051        }
052    }