| SchedulerEngine.java |
1 /**
2 * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
23 package com.liferay.portal.kernel.scheduler;
24
25 import com.liferay.portal.kernel.scheduler.messaging.SchedulerRequest;
26
27 import java.util.Date;
28 import java.util.List;
29
30 /**
31 * <a href="SchedulerEngine.java.html"><b><i>View Source</i></b></a>
32 *
33 * @author Michael C. Han
34 * @author Bruno Farache
35 *
36 */
37 public interface SchedulerEngine {
38
39 public static final String CRON_TEXT = "cronText";
40
41 public static final String DESCRIPTION = "description";
42
43 public static final String DESTINATION = "destination";
44
45 public static final String MESSAGE_BODY = "messageBody";
46
47 public List<SchedulerRequest> getScheduledJobs(String groupName)
48 throws SchedulerException;
49
50 public void schedule(
51 String groupName, String cronText, Date startDate, Date endDate,
52 String description, String destinationName, String messageBody)
53 throws SchedulerException;
54
55 public void shutdown() throws SchedulerException;
56
57 public void start() throws SchedulerException;
58
59 public void unschedule(String jobName, String groupName)
60 throws SchedulerException;
61
62 }