com.liferay.portal.kernel.scheduler
Interface SchedulerEngineHelper

All Known Implementing Classes:

SchedulerEngineHelperImpl

public interface SchedulerEngineHelper

Method Summary

abstract void	addJob(Trigger trigger, StorageType storageType, String description, String destinationName, Message message, String messageListenerClassName, String portletId, int exceptionsMaxSize)
abstract void	addJob(Trigger trigger, StorageType storageType, String description, String destinationName, Object payload, String messageListenerClassName, String portletId, int exceptionsMaxSize)
abstract void	addScriptingJob(Trigger trigger, StorageType storageType, String description, String language, String script, int exceptionsMaxSize)
abstract void	auditSchedulerJobs(Message message, TriggerState triggerState)
abstract void	delete(SchedulerEntry schedulerEntry, StorageType storageType)
abstract void	delete(String groupName, StorageType storageType)
abstract void	delete(String jobName, String groupName, StorageType storageType)
abstract String	getCronText(Calendar calendar, boolean timeZoneSensitive)
abstract String	getCronText(PortletRequest portletRequest, Calendar calendar, boolean timeZoneSensitive, int recurrenceType)
abstract Date	getEndTime(SchedulerResponse schedulerResponse)
abstract Date	getEndTime(String jobName, String groupName, StorageType storageType)
abstract Date	getFinalFireTime(SchedulerResponse schedulerResponse)
abstract Date	getFinalFireTime(String jobName, String groupName, StorageType storageType)
abstract ObjectValuePair<Exception,Date>[]	getJobExceptions(SchedulerResponse schedulerResponse)
abstract ObjectValuePair<Exception,Date>[]	getJobExceptions(String jobName, String groupName, StorageType storageType)
abstract TriggerState	getJobState(SchedulerResponse schedulerResponse)
abstract TriggerState	getJobState(String jobName, String groupName, StorageType storageType)
abstract Date	getNextFireTime(SchedulerResponse schedulerResponse)
abstract Date	getNextFireTime(String jobName, String groupName, StorageType storageType)
abstract Date	getPreviousFireTime(SchedulerResponse schedulerResponse)
abstract Date	getPreviousFireTime(String jobName, String groupName, StorageType storageType)
abstract SchedulerResponse	getScheduledJob(String jobName, String groupName, StorageType storageType)
abstract List<SchedulerResponse>	getScheduledJobs()
abstract List<SchedulerResponse>	getScheduledJobs(StorageType storageType)
abstract List<SchedulerResponse>	getScheduledJobs(String groupName, StorageType storageType)
abstract Date	getStartTime(SchedulerResponse schedulerResponse)
abstract Date	getStartTime(String jobName, String groupName, StorageType storageType)
abstract void	initialize()
abstract String	namespaceGroupName(String groupName, StorageType storageType)
abstract void	pause(String groupName, StorageType storageType)
abstract void	pause(String jobName, String groupName, StorageType storageType)
abstract void	resume(String groupName, StorageType storageType)
abstract void	resume(String jobName, String groupName, StorageType storageType)
abstract void	schedule(SchedulerEntry schedulerEntry, StorageType storageType, String portletId, int exceptionsMaxSize)
abstract void	schedule(Trigger trigger, StorageType storageType, String description, String destinationName, Message message, int exceptionsMaxSize)
abstract void	schedule(Trigger trigger, StorageType storageType, String description, String destinationName, Object payload, int exceptionsMaxSize)
abstract void	shutdown()
abstract void	start()
abstract void	suppressError(String jobName, String groupName, StorageType storageType)
abstract void	unschedule(SchedulerEntry schedulerEntry, StorageType storageType)
abstract void	unschedule(String groupName, StorageType storageType)
abstract void	unschedule(String jobName, String groupName, StorageType storageType)
abstract void	update(String jobName, String groupName, StorageType storageType, String description, String language, String script, int exceptionsMaxSize)
abstract void	update(Trigger trigger, StorageType storageType)
abstract void	updateMemorySchedulerClusterMaster()

Method Detail

addJob

void addJob(Trigger trigger,
            StorageType storageType,
            String description,
            String destinationName,
            Message message,
            String messageListenerClassName,
            String portletId,
            int exceptionsMaxSize)
            throws SchedulerException

Throws:

SchedulerException

addJob

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

Throws:

SchedulerException

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

initialize

void initialize()
                throws SchedulerException

Throws:

SchedulerException

namespaceGroupName

String namespaceGroupName(String groupName,
                          StorageType storageType)

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(SchedulerEntry schedulerEntry,
              StorageType storageType,
              String portletId,
              int exceptionsMaxSize)
              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

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

updateMemorySchedulerClusterMaster

void updateMemorySchedulerClusterMaster()
                                        throws SchedulerException

Throws:

SchedulerException