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.NightlyOutService;
021    import org.kuali.kfs.sys.batch.AbstractStep;
022    
023    /**
024     * A step to clear pending ledger entries.
025     */
026    public class ClearPendingStep extends AbstractStep {
027        private static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(ClearPendingStep.class);
028        private NightlyOutService nightlyOutService;
029    
030        /**
031         * Runs the process of deleting copied ledger entries
032         * 
033         * @param jobName the name of the job that this step is being run as part of
034         * @param jobRunDate the time/date the job is run
035         * @return that the job completed successfully
036         * @see org.kuali.kfs.sys.batch.Step#execute(String, Date)
037         */
038        public boolean execute(String jobName, Date jobRunDate) {
039            nightlyOutService.deleteCopiedPendingLedgerEntries();
040            return true;
041        }
042    
043        /**
044         * Sets the nightlyOutService attribute value.
045         * 
046         * @param nightlyOutService The nightlyOutService to set.
047         * @see org.kuali.kfs.gl.service.NightlyOutService
048         */
049        public void setNightlyOutService(NightlyOutService nightlyOutService) {
050            this.nightlyOutService = nightlyOutService;
051        }
052    }