JobSchedulerEntry


1   /*
2    * Copyright 1999-2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
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.apache.cocoon.components.cron;
17  
18  import java.util.Date  ;
19  
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 30932 2004-07-29 17:35:38Z vgritsenko $
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  }
64
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags