1   /**
2    * Copyright (c) 2000-2008 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.messaging;
24  
25  import java.io.Serializable;
26  
27  import java.util.Date;
28  
29  /**
30   * <a href="SchedulerRequest.java.html"><b><i>View Source</i></b></a>
31   *
32   * <p>
33   * A request to schedule a job for the scheduling engine. You may specify the
34   * timing of the job via the cron syntax. See
35   * http://quartz.sourceforge.net/javadoc/org/quartz/CronTrigger.html for a
36   * description of the syntax.
37   * </p>
38   *
39   * @author Michael C. Han
40   * @author Bruno Farache
41   * @author Brian Wing Shun Chan
42   *
43   */
44  public class SchedulerRequest implements Serializable {
45  
46      public static final String COMMAND_REGISTER = "REGISTER";
47  
48      public static final String COMMAND_RETRIEVE = "RETRIEVE";
49  
50      public static final String COMMAND_SHUTDOWN = "SHUTDOWN";
51  
52      public static final String COMMAND_UNREGISTER = "UNREGISTER";
53  
54      public SchedulerRequest() {
55      }
56  
57      public SchedulerRequest(String command) {
58          this(command, null, null, null, null, null, null, null, null);
59      }
60  
61      public SchedulerRequest(
62          String command, String jobName, String groupName) {
63  
64          this(command, jobName, groupName, null, null, null, null, null, null);
65      }
66  
67      public SchedulerRequest(
68          String command, String jobName, String groupName, String cronText,
69          Date startDate, Date endDate, String description, String destination,
70          String messageBody) {
71  
72          _command = command;
73          _jobName = jobName;
74          _groupName = groupName;
75          _cronText = cronText;
76          _startDate = startDate;
77          _endDate = endDate;
78          _description = description;
79          _destination = destination;
80          _messageBody = messageBody;
81      }
82  
83      public String getCommand() {
84          return _command;
85      }
86  
87      public void setCommand(String command) {
88          _command = command;
89      }
90  
91      public String getJobName() {
92          return _jobName;
93      }
94  
95      public void setJobName(String jobName) {
96          _jobName = jobName;
97      }
98  
99      public String getGroupName() {
100         return _groupName;
101     }
102 
103     public void setGroupName(String groupName) {
104         _groupName = groupName;
105     }
106 
107     public String getCronText() {
108         return _cronText;
109     }
110 
111     public void setCronText(String cronText) {
112         _cronText = cronText;
113     }
114 
115     public Date getStartDate() {
116         return _startDate;
117     }
118 
119     public void setStartDate(Date startDate) {
120         _startDate = startDate;
121     }
122 
123     public Date getEndDate() {
124         return _endDate;
125     }
126 
127     public void setEndDate(Date endDate) {
128         _endDate = endDate;
129     }
130 
131     public String getDescription() {
132         return _description;
133     }
134 
135     public void setDescription(String description) {
136         _description = description;
137     }
138 
139     public String getDestination() {
140         return _destination;
141     }
142 
143     public void setDestination(String destination) {
144         _destination = destination;
145     }
146 
147     public String getMessageBody() {
148         return _messageBody;
149     }
150 
151     public void setMessageBody(String messageBody) {
152         _messageBody = messageBody;
153     }
154 
155     private String _command;
156     private String _jobName;
157     private String _groupName;
158     private String _cronText;
159     private Date _startDate;
160     private Date _endDate;
161     private String _description;
162     private String _destination;
163     private String _messageBody;
164 
165 }