View Javadoc

1   package org.apache.turbine.modules;
2   
3   /*
4    * Copyright 2001-2005 The Apache Software Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License")
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  import org.apache.turbine.services.schedule.JobEntry;
20  
21  /***
22   * All Scheduled jobs should extend this.  The class that extends
23   * ScheduledJobs should contain the code that you actually want to
24   * execute at a specific time.  The name of this class is what you
25   * register in the JobEntry.
26   *
27   * @author <a href="mailto:mbryson@mindspring.com">Dave Bryson</a>
28   * @version $Id: ScheduledJob.java 264148 2005-08-29 14:21:04Z henning $
29   */
30  public abstract class ScheduledJob extends Assembler
31  {
32      /***
33       * Run the Jobentry from the scheduler queue.
34       *
35       * @param job The job to run.
36       */
37      public abstract void run(JobEntry job)
38              throws Exception;
39  }