| SchedulerEngine.java |
1 /**
2 * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3 *
4 * The contents of this file are subject to the terms of the Liferay Enterprise
5 * Subscription License ("License"). You may not use this file except in
6 * compliance with the License. You can obtain a copy of the License by
7 * contacting Liferay, Inc. See the License for the specific language governing
8 * permissions and limitations under the License, including but not limited to
9 * distribution rights of the Software.
10 *
11 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17 * SOFTWARE.
18 */
19
20 package com.liferay.portal.kernel.scheduler;
21
22 import com.liferay.portal.kernel.scheduler.messaging.SchedulerRequest;
23
24 import java.util.Date;
25 import java.util.List;
26
27 /**
28 * <a href="SchedulerEngine.java.html"><b><i>View Source</i></b></a>
29 *
30 * @author Michael C. Han
31 * @author Bruno Farache
32 *
33 */
34 public interface SchedulerEngine {
35
36 public static final String CRON_TEXT = "cronText";
37
38 public static final String DESCRIPTION = "description";
39
40 public static final String DESTINATION = "destination";
41
42 public static final String MESSAGE_BODY = "messageBody";
43
44 public List<SchedulerRequest> getScheduledJobs(String groupName)
45 throws SchedulerException;
46
47 public void schedule(
48 String groupName, String cronText, Date startDate, Date endDate,
49 String description, String destinationName, String messageBody)
50 throws SchedulerException;
51
52 public void shutdown() throws SchedulerException;
53
54 public void start() throws SchedulerException;
55
56 public void unschedule(String jobName, String groupName)
57 throws SchedulerException;
58
59 }