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, java.lang.String description, java.lang.String language, java.lang.String script)
void	auditSchedulerJobs(Message message, TriggerState triggerState)
void	delete(java.lang.String groupName, StorageType storageType)
void	delete(java.lang.String jobName, java.lang.String groupName, StorageType storageType)
java.util.Date	getEndTime(SchedulerResponse schedulerResponse)
TriggerState	getJobState(SchedulerResponse schedulerResponse)
java.util.Date	getNextFireTime(SchedulerResponse schedulerResponse)
java.util.Date	getPreviousFireTime(SchedulerResponse schedulerResponse)
SchedulerResponse	getScheduledJob(java.lang.String jobName, java.lang.String groupName, StorageType storageType)
java.util.List<SchedulerResponse>	getScheduledJobs()
java.util.List<SchedulerResponse>	getScheduledJobs(StorageType storageType)
java.util.List<SchedulerResponse>	getScheduledJobs(java.lang.String groupName, StorageType storageType)
java.util.Date	getStartTime(SchedulerResponse schedulerResponse)
void	pause(java.lang.String jobName, java.lang.String groupName, StorageType storageType)
void	resume(java.lang.String jobName, java.lang.String groupName, StorageType storageType)
void	run(long companyId, java.lang.String jobName, java.lang.String groupName, StorageType storageType)
void	schedule(Trigger trigger, StorageType storageType, java.lang.String description, java.lang.String destinationName, Message message)
void	schedule(Trigger trigger, StorageType storageType, java.lang.String description, java.lang.String destinationName, java.lang.Object payload)

Method Detail

addScriptingJob

void addScriptingJob(Trigger trigger,
                     StorageType storageType,
                     java.lang.String description,
                     java.lang.String language,
                     java.lang.String script)
              throws SchedulerException

Throws:

SchedulerException

auditSchedulerJobs

void auditSchedulerJobs(Message message,
                        TriggerState triggerState)
                 throws SchedulerException

Throws:

SchedulerException

delete

void delete(java.lang.String groupName,
            StorageType storageType)
     throws SchedulerException

Throws:

SchedulerException

delete

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

Throws:

SchedulerException

getEndTime

java.util.Date getEndTime(SchedulerResponse schedulerResponse)

getJobState

TriggerState getJobState(SchedulerResponse schedulerResponse)

getNextFireTime

java.util.Date getNextFireTime(SchedulerResponse schedulerResponse)

getPreviousFireTime

java.util.Date getPreviousFireTime(SchedulerResponse schedulerResponse)

getScheduledJob

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

Throws:

SchedulerException

getScheduledJobs

java.util.List<SchedulerResponse> getScheduledJobs()
                                            throws SchedulerException

Throws:

SchedulerException

getScheduledJobs

java.util.List<SchedulerResponse> getScheduledJobs(StorageType storageType)
                                            throws SchedulerException

Throws:

SchedulerException

getScheduledJobs

java.util.List<SchedulerResponse> getScheduledJobs(java.lang.String groupName,
                                                   StorageType storageType)
                                            throws SchedulerException

Throws:

SchedulerException

getStartTime

java.util.Date getStartTime(SchedulerResponse schedulerResponse)

pause

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

Throws:

SchedulerException

resume

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

Throws:

SchedulerException

run

void run(long companyId,
         java.lang.String jobName,
         java.lang.String groupName,
         StorageType storageType)
  throws SchedulerException

Throws:

SchedulerException

schedule

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

Throws:

SchedulerException

schedule

void schedule(Trigger trigger,
              StorageType storageType,
              java.lang.String description,
              java.lang.String destinationName,
              java.lang.Object payload)
       throws SchedulerException

Throws:

SchedulerException