View Javadoc

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