com.liferay.portal.kernel.scheduler.messaging
Class SchedulerRequest

java.lang.Object
  extended by com.liferay.portal.kernel.scheduler.messaging.SchedulerRequest
All Implemented Interfaces:
java.io.Serializable

public class SchedulerRequest
extends java.lang.Object
implements java.io.Serializable

View Source

A request to schedule a job for the scheduling engine. You may specify the timing of the job via the cron syntax. See http://quartz.sourceforge.net/javadoc/org/quartz/CronTrigger.html for a description of the syntax.

Author:
Michael C. Han, Bruno Farache, Brian Wing Shun Chan
See Also:
Serialized Form

Field Summary
static java.lang.String COMMAND_REGISTER
           
static java.lang.String COMMAND_RETRIEVE
           
static java.lang.String COMMAND_SHUTDOWN
           
static java.lang.String COMMAND_STARTUP
           
static java.lang.String COMMAND_UNREGISTER
           
 
Constructor Summary
SchedulerRequest()
          Deprecated.  
SchedulerRequest(java.lang.String command)
          Deprecated.  
SchedulerRequest(java.lang.String command, java.lang.String jobName, java.lang.String groupName)
          Deprecated.  
SchedulerRequest(java.lang.String command, java.lang.String jobName, java.lang.String groupName, long interval, java.util.Date startDate, java.util.Date endDate, java.lang.String description, java.lang.String destination, java.lang.String messageBody)
          Deprecated.  
SchedulerRequest(java.lang.String command, java.lang.String jobName, java.lang.String groupName, java.lang.String cronText, java.util.Date startDate, java.util.Date endDate, java.lang.String description, java.lang.String destination, java.lang.String messageBody)
          Deprecated.  
 
Method Summary
static SchedulerRequest createRegisterRequest(java.lang.String groupName, long interval, java.util.Date startDate, java.util.Date endDate, java.lang.String description, java.lang.String destination, java.lang.String messageBody)
           
static SchedulerRequest createRegisterRequest(java.lang.String groupName, java.lang.String cronText, java.util.Date startDate, java.util.Date endDate, java.lang.String description, java.lang.String destination, java.lang.String messageBody)
           
static SchedulerRequest createRegisterRequest(java.lang.String jobName, java.lang.String groupName, long interval, java.util.Date startDate, java.util.Date endDate, java.lang.String description, java.lang.String destination, java.lang.String messageBody)
           
static SchedulerRequest createRegisterRequest(java.lang.String jobName, java.lang.String groupName, java.lang.String cronText, java.util.Date startDate, java.util.Date endDate, java.lang.String description, java.lang.String destination, java.lang.String messageBody)
           
static SchedulerRequest createRetrieveRequest(java.lang.String groupName)
           
static SchedulerRequest createRetrieveResponseRequest(java.lang.String jobName, java.lang.String groupName, long interval, java.util.Date startDate, java.util.Date endDate, java.lang.String description, java.lang.String messageBody)
           
static SchedulerRequest createRetrieveResponseRequest(java.lang.String jobName, java.lang.String groupName, java.lang.String cronText, java.util.Date startDate, java.util.Date endDate, java.lang.String description, java.lang.String messageBody)
           
static SchedulerRequest createShutdownRequest()
           
static SchedulerRequest createStartupRequest()
           
static SchedulerRequest createUnregisterRequest(java.lang.String jobName, java.lang.String groupName)
           
 java.lang.String getCommand()
           
 java.lang.String getCronText()
           
 java.lang.String getDescription()
           
 java.lang.String getDestination()
           
 java.util.Date getEndDate()
           
 java.lang.String getGroupName()
           
 long getInterval()
           
 java.lang.String getJobName()
           
 java.lang.String getMessageBody()
           
 java.util.Date getStartDate()
           
 TriggerType getTriggerType()
           
 void setCommand(java.lang.String command)
           
 void setCronText(java.lang.String cronText)
           
 void setDescription(java.lang.String description)
           
 void setDestination(java.lang.String destination)
           
 void setEndDate(java.util.Date endDate)
           
 void setGroupName(java.lang.String groupName)
           
 void setInterval(long interval)
           
 void setJobName(java.lang.String jobName)
           
 void setMessageBody(java.lang.String messageBody)
           
 void setStartDate(java.util.Date startDate)
           
 void setTriggerType(TriggerType triggerType)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMMAND_REGISTER

public static final java.lang.String COMMAND_REGISTER
See Also:
Constant Field Values

COMMAND_RETRIEVE

public static final java.lang.String COMMAND_RETRIEVE
See Also:
Constant Field Values

COMMAND_SHUTDOWN

public static final java.lang.String COMMAND_SHUTDOWN
See Also:
Constant Field Values

COMMAND_STARTUP

public static final java.lang.String COMMAND_STARTUP
See Also:
Constant Field Values

COMMAND_UNREGISTER

public static final java.lang.String COMMAND_UNREGISTER
See Also:
Constant Field Values
Constructor Detail

SchedulerRequest

public SchedulerRequest()
Deprecated. 


SchedulerRequest

public SchedulerRequest(java.lang.String command)
Deprecated. 


SchedulerRequest

public SchedulerRequest(java.lang.String command,
                        java.lang.String jobName,
                        java.lang.String groupName)
Deprecated. 


SchedulerRequest

public SchedulerRequest(java.lang.String command,
                        java.lang.String jobName,
                        java.lang.String groupName,
                        long interval,
                        java.util.Date startDate,
                        java.util.Date endDate,
                        java.lang.String description,
                        java.lang.String destination,
                        java.lang.String messageBody)
Deprecated. 


SchedulerRequest

public SchedulerRequest(java.lang.String command,
                        java.lang.String jobName,
                        java.lang.String groupName,
                        java.lang.String cronText,
                        java.util.Date startDate,
                        java.util.Date endDate,
                        java.lang.String description,
                        java.lang.String destination,
                        java.lang.String messageBody)
Deprecated. 

Method Detail

createRegisterRequest

public static SchedulerRequest createRegisterRequest(java.lang.String groupName,
                                                     long interval,
                                                     java.util.Date startDate,
                                                     java.util.Date endDate,
                                                     java.lang.String description,
                                                     java.lang.String destination,
                                                     java.lang.String messageBody)

createRegisterRequest

public static SchedulerRequest createRegisterRequest(java.lang.String groupName,
                                                     java.lang.String cronText,
                                                     java.util.Date startDate,
                                                     java.util.Date endDate,
                                                     java.lang.String description,
                                                     java.lang.String destination,
                                                     java.lang.String messageBody)

createRegisterRequest

public static SchedulerRequest createRegisterRequest(java.lang.String jobName,
                                                     java.lang.String groupName,
                                                     long interval,
                                                     java.util.Date startDate,
                                                     java.util.Date endDate,
                                                     java.lang.String description,
                                                     java.lang.String destination,
                                                     java.lang.String messageBody)

createRegisterRequest

public static SchedulerRequest createRegisterRequest(java.lang.String jobName,
                                                     java.lang.String groupName,
                                                     java.lang.String cronText,
                                                     java.util.Date startDate,
                                                     java.util.Date endDate,
                                                     java.lang.String description,
                                                     java.lang.String destination,
                                                     java.lang.String messageBody)

createRetrieveRequest

public static SchedulerRequest createRetrieveRequest(java.lang.String groupName)

createRetrieveResponseRequest

public static SchedulerRequest createRetrieveResponseRequest(java.lang.String jobName,
                                                             java.lang.String groupName,
                                                             long interval,
                                                             java.util.Date startDate,
                                                             java.util.Date endDate,
                                                             java.lang.String description,
                                                             java.lang.String messageBody)

createRetrieveResponseRequest

public static SchedulerRequest createRetrieveResponseRequest(java.lang.String jobName,
                                                             java.lang.String groupName,
                                                             java.lang.String cronText,
                                                             java.util.Date startDate,
                                                             java.util.Date endDate,
                                                             java.lang.String description,
                                                             java.lang.String messageBody)

createShutdownRequest

public static SchedulerRequest createShutdownRequest()

createStartupRequest

public static SchedulerRequest createStartupRequest()

createUnregisterRequest

public static SchedulerRequest createUnregisterRequest(java.lang.String jobName,
                                                       java.lang.String groupName)

getCommand

public java.lang.String getCommand()

getCronText

public java.lang.String getCronText()

getDescription

public java.lang.String getDescription()

getDestination

public java.lang.String getDestination()

getEndDate

public java.util.Date getEndDate()

getGroupName

public java.lang.String getGroupName()

getInterval

public long getInterval()

getJobName

public java.lang.String getJobName()

getMessageBody

public java.lang.String getMessageBody()

getStartDate

public java.util.Date getStartDate()

getTriggerType

public TriggerType getTriggerType()

setCommand

public void setCommand(java.lang.String command)

setCronText

public void setCronText(java.lang.String cronText)

setDescription

public void setDescription(java.lang.String description)

setDestination

public void setDestination(java.lang.String destination)

setEndDate

public void setEndDate(java.util.Date endDate)

setGroupName

public void setGroupName(java.lang.String groupName)

setInterval

public void setInterval(long interval)

setJobName

public void setJobName(java.lang.String jobName)

setMessageBody

public void setMessageBody(java.lang.String messageBody)

setStartDate

public void setStartDate(java.util.Date startDate)

setTriggerType

public void setTriggerType(TriggerType triggerType)