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.sys.batch.service;
017    
018    import java.io.File;
019    import java.util.List;
020    
021    import org.kuali.kfs.sys.batch.FilePurgeCustomAge;
022    
023    /**
024     * Methods needed to purge files in the FilePurgeStep
025     */
026    public interface FilePurgeService {
027        
028        /**
029         * Purges old files from the given directory
030         * @param directory the directory to purge
031         * @param customAges the List of customized ages for files which do not follow the standard
032         */
033        public abstract void purgeFiles(String directory, List<FilePurgeCustomAge> customAges);
034        
035        /**
036         * Returns the age in days that files matching this custom age should leave matching files before purging
037         * @param customAge a custom age to check
038         * @return the number of days needed to elapse before purging
039         */
040        public abstract int getDaysBeforePurgeForCustomAge(FilePurgeCustomAge customAge);
041        
042        /**
043         * Looks up the parameter for the standard number of days before a file should be purged
044         * @return the standard number of days before a file should be purged
045         */
046        public abstract int getStandardDaysBeforePurge();
047    }