1 /*
2 * Copyright 2009 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.ole.sys.batch.service;
17
18 import java.util.List;
19
20 import org.kuali.ole.sys.batch.FilePurgeCustomAge;
21
22 /**
23 * Methods needed to purge files in the FilePurgeStep
24 */
25 public interface FilePurgeService {
26
27 /**
28 * Purges old files from the given directory
29 * @param directory the directory to purge
30 * @param customAges the List of customized ages for files which do not follow the standard
31 */
32 public abstract void purgeFiles(String directory, List<FilePurgeCustomAge> customAges);
33
34 /**
35 * Returns the age in days that files matching this custom age should leave matching files before purging
36 * @param customAge a custom age to check
37 * @return the number of days needed to elapse before purging
38 */
39 public abstract int getDaysBeforePurgeForCustomAge(FilePurgeCustomAge customAge);
40
41 /**
42 * Looks up the parameter for the standard number of days before a file should be purged
43 * @return the standard number of days before a file should be purged
44 */
45 public abstract int getStandardDaysBeforePurge();
46 }