com.liferay.portal.kernel.scheduler

Interface SchedulerEngineHelper

public interface SchedulerEngineHelper

Author:

Michael C. Han

Method Summary

Modifier and Type	Method and Description
void	addScriptingJob(Trigger trigger, StorageType storageType, String description, String language, String script, int exceptionsMaxSize)
void	auditSchedulerJobs(Message message, TriggerState triggerState)
void	delete(SchedulerEntry schedulerEntry, StorageType storageType)
void	delete(String groupName, StorageType storageType)
void	delete(String jobName, String groupName, StorageType storageType)
String	getCronText(Calendar calendar, boolean timeZoneSensitive)
String	getCronText(PortletRequest portletRequest, Calendar calendar, boolean timeZoneSensitive, int recurrenceType)
Date	getEndTime(SchedulerResponse schedulerResponse)
Date	getEndTime(String jobName, String groupName, StorageType storageType)
Date	getFinalFireTime(SchedulerResponse schedulerResponse)
Date	getFinalFireTime(String jobName, String groupName, StorageType storageType)
ObjectValuePair<Exception,Date>[]	getJobExceptions(SchedulerResponse schedulerResponse)
ObjectValuePair<Exception,Date>[]	getJobExceptions(String jobName, String groupName, StorageType storageType)
TriggerState	getJobState(SchedulerResponse schedulerResponse)
TriggerState	getJobState(String jobName, String groupName, StorageType storageType)
Date	getNextFireTime(SchedulerResponse schedulerResponse)
Date	getNextFireTime(String jobName, String groupName, StorageType storageType)
Date	getPreviousFireTime(SchedulerResponse schedulerResponse)
Date	getPreviousFireTime(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)
Date	getStartTime(SchedulerResponse schedulerResponse)
Date	getStartTime(String jobName, String groupName, StorageType storageType)
void	pause(String groupName, StorageType storageType)
void	pause(String jobName, String groupName, StorageType storageType)
void	register(MessageListener messageListener, SchedulerEntry schedulerEntry, String destinationName)
void	resume(String groupName, StorageType storageType)
void	resume(String jobName, String groupName, StorageType storageType)
void	schedule(Trigger trigger, StorageType storageType, String description, String destinationName, Message message, int exceptionsMaxSize)
void	schedule(Trigger trigger, StorageType storageType, String description, String destinationName, Object payload, int exceptionsMaxSize)
void	shutdown()
void	start()
void	suppressError(String jobName, String groupName, StorageType storageType)
void	unregister(MessageListener messageListener)
void	unschedule(SchedulerEntry schedulerEntry, StorageType storageType)
void	unschedule(String groupName, StorageType storageType)
void	unschedule(String jobName, String groupName, StorageType storageType)
void	update(String jobName, String groupName, StorageType storageType, String description, String language, String script, int exceptionsMaxSize)
void	update(Trigger trigger, StorageType storageType)

Method Detail

addScriptingJob

void addScriptingJob(Trigger trigger,
                     StorageType storageType,
                     String description,
                     String language,
                     String script,
                     int exceptionsMaxSize)
              throws SchedulerException

Throws:

SchedulerException

auditSchedulerJobs

void auditSchedulerJobs(Message message,
                        TriggerState triggerState)
                 throws SchedulerException

Throws:

SchedulerException

delete

void delete(SchedulerEntry schedulerEntry,
            StorageType storageType)
     throws SchedulerException

Throws:

SchedulerException

delete

void delete(String groupName,
            StorageType storageType)
     throws SchedulerException

Throws:

SchedulerException

delete

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

Throws:

SchedulerException

getCronText

String getCronText(Calendar calendar,
                   boolean timeZoneSensitive)

getCronText

String getCronText(PortletRequest portletRequest,
                   Calendar calendar,
                   boolean timeZoneSensitive,
                   int recurrenceType)

getEndTime

Date getEndTime(SchedulerResponse schedulerResponse)

getEndTime

Date getEndTime(String jobName,
                String groupName,
                StorageType storageType)
         throws SchedulerException

Throws:

SchedulerException

getFinalFireTime

Date getFinalFireTime(SchedulerResponse schedulerResponse)

getFinalFireTime

Date getFinalFireTime(String jobName,
                      String groupName,
                      StorageType storageType)
               throws SchedulerException

Throws:

SchedulerException

getJobExceptions

ObjectValuePair<Exception,Date>[] getJobExceptions(SchedulerResponse schedulerResponse)

getJobExceptions

ObjectValuePair<Exception,Date>[] getJobExceptions(String jobName,
                                                   String groupName,
                                                   StorageType storageType)
                                            throws SchedulerException

Throws:

SchedulerException

getJobState

TriggerState getJobState(SchedulerResponse schedulerResponse)

getJobState

TriggerState getJobState(String jobName,
                         String groupName,
                         StorageType storageType)
                  throws SchedulerException

Throws:

SchedulerException

getNextFireTime

Date getNextFireTime(SchedulerResponse schedulerResponse)

getNextFireTime

Date getNextFireTime(String jobName,
                     String groupName,
                     StorageType storageType)
              throws SchedulerException

Throws:

SchedulerException

getPreviousFireTime

Date getPreviousFireTime(SchedulerResponse schedulerResponse)

getPreviousFireTime

Date getPreviousFireTime(String jobName,
                         String groupName,
                         StorageType storageType)
                  throws SchedulerException

Throws:

SchedulerException

getScheduledJob

SchedulerResponse getScheduledJob(String jobName,
                                  String groupName,
                                  StorageType storageType)
                           throws SchedulerException

Throws:

SchedulerException

getScheduledJobs

List<SchedulerResponse> getScheduledJobs()
                                  throws SchedulerException

Throws:

SchedulerException

getScheduledJobs

List<SchedulerResponse> getScheduledJobs(StorageType storageType)
                                  throws SchedulerException

Throws:

SchedulerException

getScheduledJobs

List<SchedulerResponse> getScheduledJobs(String groupName,
                                         StorageType storageType)
                                  throws SchedulerException

Throws:

SchedulerException

getStartTime

Date getStartTime(SchedulerResponse schedulerResponse)

getStartTime

Date getStartTime(String jobName,
                  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

register

void register(MessageListener messageListener,
              SchedulerEntry schedulerEntry,
              String destinationName)

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,
              StorageType storageType,
              String description,
              String destinationName,
              Message message,
              int exceptionsMaxSize)
       throws SchedulerException

Throws:

SchedulerException

schedule

void schedule(Trigger trigger,
              StorageType storageType,
              String description,
              String destinationName,
              Object payload,
              int exceptionsMaxSize)
       throws SchedulerException

Throws:

SchedulerException

shutdown

void shutdown()
       throws SchedulerException

Throws:

SchedulerException

start

void start()
    throws SchedulerException

Throws:

SchedulerException

suppressError

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

Throws:

SchedulerException

unregister

void unregister(MessageListener messageListener)

unschedule

void unschedule(SchedulerEntry schedulerEntry,
                StorageType storageType)
         throws SchedulerException

Throws:

SchedulerException

unschedule

void unschedule(String groupName,
                StorageType storageType)
         throws SchedulerException

Throws:

SchedulerException

unschedule

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

Throws:

SchedulerException

update

void update(String jobName,
            String groupName,
            StorageType storageType,
            String description,
            String language,
            String script,
            int exceptionsMaxSize)
     throws SchedulerException

Throws:

SchedulerException

update

void update(Trigger trigger,
            StorageType storageType)
     throws SchedulerException

Throws:

SchedulerException