1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights 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  public interface SchedulerEngine {
37  
38      public static final String CRON_TEXT = "cronText";
39  
40      public static final String DESCRIPTION = "description";
41  
42      public static final String DESTINATION = "destination";
43  
44      public static final String MESSAGE_BODY = "messageBody";
45  
46      public List<SchedulerRequest> getScheduledJobs(String groupName)
47          throws SchedulerException;
48  
49      public void schedule(
50              String groupName, long interval, Date startDate, Date endDate,
51              String description, String destinationName, String messageBody)
52          throws SchedulerException;
53  
54      public void schedule(
55              String groupName, String cronText, Date startDate, Date endDate,
56              String description, String destinationName, String messageBody)
57          throws SchedulerException;
58  
59      public void shutdown() throws SchedulerException;
60  
61      public void start() throws SchedulerException;
62  
63      public void unschedule(String jobName, String groupName)
64          throws SchedulerException;
65  
66  }