com.liferay.portal.kernel.scheduler
Interface SchedulerEngine

public interface SchedulerEngine

View Source

Author:

Michael C. Han, Bruno Farache

Field Summary

static java.lang.String	CRON_TEXT
static java.lang.String	DESCRIPTION
static java.lang.String	DESTINATION
static java.lang.String	MESSAGE_BODY

Method Summary

java.util.List<SchedulerRequest>	getScheduledJobs(java.lang.String groupName)
void	schedule(java.lang.String groupName, java.lang.String cronText, java.util.Date startDate, java.util.Date endDate, java.lang.String description, java.lang.String destinationName, java.lang.String messageBody)
void	shutdown()
void	start()
void	unschedule(java.lang.String jobName, java.lang.String groupName)

Field Detail

CRON_TEXT

static final java.lang.String CRON_TEXT

See Also:

Constant Field Values

DESCRIPTION

static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

DESTINATION

static final java.lang.String DESTINATION

See Also:

Constant Field Values

MESSAGE_BODY

static final java.lang.String MESSAGE_BODY

See Also:

Constant Field Values

Method Detail

getScheduledJobs

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

Throws:

SchedulerException

schedule

void schedule(java.lang.String groupName,
              java.lang.String cronText,
              java.util.Date startDate,
              java.util.Date endDate,
              java.lang.String description,
              java.lang.String destinationName,
              java.lang.String messageBody)
              throws SchedulerException

Throws:

SchedulerException

shutdown

void shutdown()
              throws SchedulerException

Throws:

SchedulerException

start

void start()
           throws SchedulerException

Throws:

SchedulerException

unschedule

void unschedule(java.lang.String jobName,
                java.lang.String groupName)
                throws SchedulerException

Throws:

SchedulerException