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 org.kuali.kfs.gl.service.NightlyOutService;
019    import org.kuali.kfs.sys.batch.AbstractWrappedBatchStep;
020    import org.kuali.kfs.sys.batch.service.WrappedBatchExecutorService.CustomBatchExecutor;
021    
022    /**
023     * Runs the nightly out process, which is the process that preps general ledger pending entries to be fed to the scrubber.
024     */
025    public class NightlyOutStep extends AbstractWrappedBatchStep {
026        private NightlyOutService nightlyOutService;
027    
028        /**
029         * @return a proper executor for the NightlyOutStep
030         */
031        @Override
032        protected CustomBatchExecutor getCustomBatchExecutor() {
033            return new CustomBatchExecutor() {
034                /**
035                 * Runs the nightly out process.
036                 * 
037                 * @return true if the job completed successfully, false if otherwise
038                 * @see org.kuali.kfs.sys.batch.Step#execute(String, Date)
039                 */
040                public boolean execute() {
041                    nightlyOutService.copyApprovedPendingLedgerEntries();
042                    return true;
043                }
044            };
045        }
046    
047        /**
048         * Sets the nightlyOutService attribute value.
049         * 
050         * @param nightlyOutService The nightlyOutService to set.
051         * @see org.kuali.kfs.gl.service.NightlyOutService
052         */
053        public void setNightlyOutService(NightlyOutService nightlyOutService) {
054            this.nightlyOutService = nightlyOutService;
055        }
056    }