com.liferay.portal.kernel.scheduler

Interface SchedulerEngine

@ProviderType
public interface SchedulerEngine

Author:

Michael C. Han, Bruno Farache, Shuyang Zhou, Tina Tian

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESCRIPTION
static String	DESTINATION_NAME
static String	DISABLE
static String	END_TIME
static String	EXCEPTIONS_MAX_SIZE
static String	FINAL_FIRE_TIME
static String	GROUP_NAME
static String	JOB_NAME
static String	JOB_STATE
static String	LANGUAGE
static String	MESSAGE
static String	MESSAGE_LISTENER_CLASS_NAME Deprecated. As of Wilberforce (7.0.x)
static String	MESSAGE_LISTENER_UUID Deprecated. As of Wilberforce (7.0.x)
static String	NEXT_FIRE_TIME
static String	PORTLET_ID Deprecated. As of Wilberforce (7.0.x)
static String	PREVIOUS_FIRE_TIME
static String	RECEIVER_KEY Deprecated. As of Wilberforce (7.0.x)
static String	SCHEDULER
static String	SCHEDULER_CLUSTER_INVOKING
static String	SCRIPT
static String	START_TIME
static String	STORAGE_TYPE

Method Summary

Modifier and Type	Method and Description
void	delete(String groupName, StorageType storageType)
void	delete(String jobName, String groupName, StorageType storageType)
SchedulerResponse	getScheduledJob(String jobName, String groupName, StorageType storageType)
List<SchedulerResponse>	getScheduledJobs()
List<SchedulerResponse>	getScheduledJobs(StorageType storageType)
List<SchedulerResponse>	getScheduledJobs(String groupName, StorageType storageType)
void	pause(String groupName, StorageType storageType)
void	pause(String jobName, String groupName, StorageType storageType)
void	resume(String groupName, StorageType storageType)
void	resume(String jobName, String groupName, StorageType storageType)
void	schedule(Trigger trigger, String description, String destinationName, Message message, StorageType storageType)
void	shutdown()
void	start()
void	suppressError(String jobName, String groupName, StorageType storageType)
void	unschedule(String groupName, StorageType storageType)
void	unschedule(String jobName, String groupName, StorageType storageType)
void	update(Trigger trigger, StorageType storageType)
void	validateTrigger(Trigger trigger, StorageType storageType)

Field Detail

DESCRIPTION

static final String DESCRIPTION

See Also:

Constant Field Values

DESTINATION_NAME

static final String DESTINATION_NAME

See Also:

Constant Field Values

DISABLE

static final String DISABLE

See Also:

Constant Field Values

END_TIME

static final String END_TIME

See Also:

Constant Field Values

EXCEPTIONS_MAX_SIZE

static final String EXCEPTIONS_MAX_SIZE

See Also:

Constant Field Values

FINAL_FIRE_TIME

static final String FINAL_FIRE_TIME

See Also:

Constant Field Values

GROUP_NAME

static final String GROUP_NAME

See Also:

Constant Field Values

JOB_NAME

static final String JOB_NAME

See Also:

Constant Field Values

JOB_STATE

static final String JOB_STATE

See Also:

Constant Field Values

LANGUAGE

static final String LANGUAGE

See Also:

Constant Field Values

MESSAGE

static final String MESSAGE

See Also:

Constant Field Values

MESSAGE_LISTENER_CLASS_NAME

@Deprecated
static final String MESSAGE_LISTENER_CLASS_NAME

Deprecated. As of Wilberforce (7.0.x)

See Also:

Constant Field Values

MESSAGE_LISTENER_UUID

@Deprecated
static final String MESSAGE_LISTENER_UUID

Deprecated. As of Wilberforce (7.0.x)

See Also:

Constant Field Values

NEXT_FIRE_TIME

static final String NEXT_FIRE_TIME

See Also:

Constant Field Values

PORTLET_ID

@Deprecated
static final String PORTLET_ID

Deprecated. As of Wilberforce (7.0.x)

See Also:

Constant Field Values

PREVIOUS_FIRE_TIME

static final String PREVIOUS_FIRE_TIME

See Also:

Constant Field Values

RECEIVER_KEY

@Deprecated
static final String RECEIVER_KEY

Deprecated. As of Wilberforce (7.0.x)

See Also:

Constant Field Values

SCHEDULER

static final String SCHEDULER

See Also:

Constant Field Values

SCHEDULER_CLUSTER_INVOKING

static final String SCHEDULER_CLUSTER_INVOKING

See Also:

Constant Field Values

SCRIPT

static final String SCRIPT

See Also:

Constant Field Values

START_TIME

static final String START_TIME

See Also:

Constant Field Values

STORAGE_TYPE

static final String STORAGE_TYPE

See Also:

Constant Field Values

Method Detail

delete

void delete(String groupName,
            StorageType storageType)
     throws SchedulerException

Throws:

SchedulerException

delete

void delete(String jobName,
            String groupName,
            StorageType storageType)
     throws SchedulerException

Throws:

SchedulerException

getScheduledJob

@MessagingProxy(mode=SYNC)
SchedulerResponse getScheduledJob(String jobName,
                                                             String groupName,
                                                             StorageType storageType)
                                                      throws SchedulerException

Throws:

SchedulerException

getScheduledJobs

@MessagingProxy(mode=SYNC)
List<SchedulerResponse> getScheduledJobs()
                                                             throws SchedulerException

Throws:

SchedulerException

getScheduledJobs

@MessagingProxy(mode=SYNC)
List<SchedulerResponse> getScheduledJobs(StorageType storageType)
                                                             throws SchedulerException

Throws:

SchedulerException

getScheduledJobs

@MessagingProxy(mode=SYNC)
List<SchedulerResponse> getScheduledJobs(String groupName,
                                                                    StorageType storageType)
                                                             throws SchedulerException

Throws:

SchedulerException

pause

void pause(String groupName,
           StorageType storageType)
    throws SchedulerException

Throws:

SchedulerException

pause

void pause(String jobName,
           String groupName,
           StorageType storageType)
    throws SchedulerException

Throws:

SchedulerException

resume

void resume(String groupName,
            StorageType storageType)
     throws SchedulerException

Throws:

SchedulerException

resume

void resume(String jobName,
            String groupName,
            StorageType storageType)
     throws SchedulerException

Throws:

SchedulerException

schedule

void schedule(Trigger trigger,
              String description,
              String destinationName,
              Message message,
              StorageType storageType)
       throws SchedulerException

Throws:

SchedulerException

shutdown

@MessagingProxy(local=true,
                mode=SYNC)
void shutdown()
                                                              throws SchedulerException

Throws:

SchedulerException

start

@MessagingProxy(local=true,
                mode=SYNC)
void start()
                                                           throws SchedulerException

Throws:

SchedulerException

suppressError

void suppressError(String jobName,
                   String groupName,
                   StorageType storageType)
            throws SchedulerException

Throws:

SchedulerException

unschedule

@MessagingProxy(mode=SYNC)
void unschedule(String groupName,
                                           StorageType storageType)
                                    throws SchedulerException

Throws:

SchedulerException

unschedule

@MessagingProxy(mode=SYNC)
void unschedule(String jobName,
                                           String groupName,
                                           StorageType storageType)
                                    throws SchedulerException

Throws:

SchedulerException

update

void update(Trigger trigger,
            StorageType storageType)
     throws SchedulerException

Throws:

SchedulerException

validateTrigger

@MessagingProxy(mode=SYNC)
void validateTrigger(Trigger trigger,
                                                StorageType storageType)
                                         throws SchedulerException

Throws:

SchedulerException