View Javadoc
1 package org.apache.turbine.services.schedule; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Turbine" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * "Apache Turbine", nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>;. 55 */ 56 57 import java.util.Vector; 58 import org.apache.turbine.services.Service; 59 60 /*** 61 * ScheduleService interface. 62 * 63 * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a> 64 * @version $Id: ScheduleService.java,v 1.1.1.1 2001/08/16 05:09:15 jvanzyl Exp $ 65 */ 66 public interface ScheduleService 67 extends Service 68 { 69 public static final String SERVICE_NAME = "SchedulerService"; 70 71 /*** 72 * Get a specific Job from Storage. 73 * 74 * @param oid The int id for the job. 75 * @return A JobEntry. 76 * @exception Exception, a generic exception. 77 */ 78 public JobEntry getJob(int oid) 79 throws Exception; 80 81 /*** 82 * Add a new job to the queue. 83 * 84 * @param je A JobEntry with the job to add. 85 * @exception Exception, a generic exception. 86 */ 87 public void addJob(JobEntry je) 88 throws Exception; 89 90 /*** 91 * Modify a Job. 92 * 93 * @param je A JobEntry with the job to modify 94 * @exception Exception, a generic exception. 95 */ 96 public void updateJob(JobEntry je) 97 throws Exception; 98 99 /*** 100 * Remove a job from the queue. 101 * 102 * @param je A JobEntry with the job to remove. 103 * @exception Exception, a generic exception. 104 */ 105 public void removeJob(JobEntry je) 106 throws Exception; 107 108 /*** 109 * List jobs in the queue. This is used by the scheduler UI. 110 * 111 * @return A Vector of jobs. 112 */ 113 public Vector listJobs(); 114 }

This page was automatically generated by Maven