KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > quartz > SchedulerFactory


1
2 /*
3  * Copyright 2004-2005 OpenSymphony
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6  * use this file except in compliance with the License. You may obtain a copy
7  * of the License at
8  *
9  * 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, WITHOUT
13  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14  * License for the specific language governing permissions and limitations
15  * under the License.
16  *
17  */
18
19 /*
20  * Previously Copyright (c) 2001-2004 James House
21  */
22 package org.quartz;
23
24 import java.util.Collection JavaDoc;
25
26 /**
27  * <p>
28  * Provides a mechanism for obtaining client-usable handles to <code>Scheduler</code>
29  * instances.
30  * </p>
31  *
32  * @see Scheduler
33  * @see org.quartz.impl.StdSchedulerFactory
34  *
35  * @author James House
36  */
37 public interface SchedulerFactory {
38
39     /*
40      * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
41      *
42      * Interface.
43      *
44      * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
45      */
46
47     /**
48      * <p>
49      * Returns a client-usable handle to a <code>Scheduler</code>.
50      * </p>
51      *
52      * @throws SchedulerException
53      * if there is a problem with the underlying <code>Scheduler</code>.
54      */
55     Scheduler getScheduler() throws SchedulerException;
56
57     /**
58      * <p>
59      * Returns a handle to the Scheduler with the given name, if it exists.
60      * </p>
61      */
62     Scheduler getScheduler(String JavaDoc schedName) throws SchedulerException;
63
64     /**
65      * <p>
66      * Returns handles to all known Schedulers (made by any SchedulerFactory
67      * within this jvm.).
68      * </p>
69      */
70     Collection JavaDoc getAllSchedulers() throws SchedulerException;
71
72 }
73
Popular Tags