com.liferay.portal.kernel.scheduler
Interface SchedulerEngine


public interface SchedulerEngine

View Source

Author:
Michael C. Han, Bruno Farache, Shuyang Zhou

Field Summary
static java.lang.String DESCRIPTION
           
static int DESCRIPTION_MAX_LENGTH
           
static java.lang.String DESTINATION
           
static java.lang.String DISABLE
           
static int GROUP_NAME_MAX_LENGTH
           
static int JOB_NAME_MAX_LENGTH
           
static java.lang.String MESSAGE
           
static java.lang.String RECEIVER_KEY
           
 
Method Summary
 java.util.List<SchedulerRequest> getScheduledJobs(java.lang.String groupName)
           
 void schedule(Trigger trigger, java.lang.String description, java.lang.String destinationName, Message message)
           
 void shutdown()
           
 void start()
           
 void unschedule(Trigger trigger)
           
 

Field Detail

DESCRIPTION

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

DESCRIPTION_MAX_LENGTH

static final int DESCRIPTION_MAX_LENGTH
See Also:
Constant Field Values

DESTINATION

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

DISABLE

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

GROUP_NAME_MAX_LENGTH

static final int GROUP_NAME_MAX_LENGTH
See Also:
Constant Field Values

JOB_NAME_MAX_LENGTH

static final int JOB_NAME_MAX_LENGTH
See Also:
Constant Field Values

MESSAGE

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

RECEIVER_KEY

static final java.lang.String RECEIVER_KEY
See Also:
Constant Field Values
Method Detail

getScheduledJobs

java.util.List<SchedulerRequest> getScheduledJobs(java.lang.String groupName)
                                                  throws SchedulerException
Throws:
SchedulerException

schedule

void schedule(Trigger trigger,
              java.lang.String description,
              java.lang.String destinationName,
              Message message)
              throws SchedulerException
Throws:
SchedulerException

shutdown

void shutdown()
              throws SchedulerException
Throws:
SchedulerException

start

void start()
           throws SchedulerException
Throws:
SchedulerException

unschedule

void unschedule(Trigger trigger)
                throws SchedulerException
Throws:
SchedulerException