01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.components.cron;
18:
19: import java.util.Date;
20:
21: /**
22: * Interface for classes holding scheduled job entries.
23: *
24: * @author <a href="mailto:giacomo@apache.org">Giacomo Pati</a>
25: * @version CVS $Id: JobSchedulerEntry.java 433543 2006-08-22 06:22:54Z crossley $
26: */
27: public interface JobSchedulerEntry {
28: /**
29: * The name of the role/class of the job
30: *
31: * @return Name of the role/class of this job
32: */
33: String getJobName();
34:
35: /**
36: * Return name of entry.
37: *
38: * @return the name of the entry
39: */
40: String getName();
41:
42: /**
43: * Retrieve time when this job should run next.
44: *
45: * @return the time in milliseconds when job should run
46: */
47: Date getNextTime();
48:
49: /**
50: * Is this job currently running?
51: *
52: * @return whether this job is currently running?
53: */
54: boolean isRunning();
55:
56: /**
57: * Get a human readable representation of the schedule of this entry. Is up to an implementation how it presents
58: * the schedule for this entry
59: *
60: * @return the human readable representation of the schedule of this entry
61: */
62: String getSchedule();
63: }
|