org.pentaho.platform.api.engine
Interface ISubscriptionScheduler

All Known Implementing Classes:

QuartzSubscriptionScheduler

public interface ISubscriptionScheduler

Interface class between the subscription repository and the implementation of the scheduler.

Author:

dmoran

Method Summary

IScheduledJob	deleteJob(java.lang.String jobName) Delete the job.
IScheduledJob	executeJob(java.lang.String jobName) Execute the job.
java.lang.String	getCronSummary(java.lang.String cron)
IScheduledJob	getScheduledJob(java.lang.String schedRef) Returns the IScheduledJob for the passed in schedule reference from the scheduling system
java.util.Map<java.lang.String,IScheduledJob>	getScheduledJobMap()
java.util.List	getScheduledJobs() Returns a List of all IScheduledJobs that are currently in the subscription scheduling system
int	getSchedulerState()
IScheduledJob	pauseJob(java.lang.String jobName) Pause the job.
void	pauseScheduler()
IScheduledJob	resumeJob(java.lang.String jobName) Resume the job.
void	resumeScheduler()
IScheduledJob	scheduleJob(ISchedule schedule)
java.util.List	syncSchedule(java.util.List newSchedules) Synchronizes schedules between the subscription repos and the scheduling system
IScheduledJob	syncSchedule(java.lang.String oldScheduleReference, ISchedule newSchedule) Synchronizes schedules between the subscription repos and the scheduling system

Method Detail

syncSchedule

IScheduledJob syncSchedule(java.lang.String oldScheduleReference,
                           ISchedule newSchedule)
                           throws SubscriptionSchedulerException

Synchronizes schedules between the subscription repos and the scheduling system

Parameters:

oldSchedule - The name of the schedule to modify or delete. If null, then the operation is treated as an add.

newSchedule - The schedule to modify or add. If null, then the operation is treated as an delete.

Returns:

true if successfull

Throws:

SubscriptionSchedulerException

syncSchedule

java.util.List syncSchedule(java.util.List newSchedules)
                            throws java.lang.Exception

Synchronizes schedules between the subscription repos and the scheduling system

Parameters:

newSchedules - The list of schedules that should exist. Any schedules not in the list should be deleted

Returns:

list of exception messages

Throws:

java.lang.Exception

getScheduledJobs

java.util.List getScheduledJobs()

Returns a List of all IScheduledJobs that are currently in the subscription scheduling system

getScheduledJob

IScheduledJob getScheduledJob(java.lang.String schedRef)
                              throws SubscriptionSchedulerException

Returns the IScheduledJob for the passed in schedule reference from the scheduling system

Throws:

java.lang.Exception

SubscriptionSchedulerException

getScheduledJobMap

java.util.Map<java.lang.String,IScheduledJob> getScheduledJobMap()
                                                                 throws java.lang.Exception

Throws:

java.lang.Exception

pauseJob

IScheduledJob pauseJob(java.lang.String jobName)
                       throws java.lang.Exception

Pause the job. NOTE: in the quartz implementation, the value of the jobName parameter should be the trigger name associated with the job to be paused.

Parameters:

jobName -

Returns:

Throws:

java.lang.Exception

resumeJob

IScheduledJob resumeJob(java.lang.String jobName)
                        throws java.lang.Exception

Resume the job. NOTE: in the quartz implementation, the value of the jobName parameter should be the trigger name associated with the job to be resumed.

Parameters:

jobName -

Returns:

Throws:

java.lang.Exception

executeJob

IScheduledJob executeJob(java.lang.String jobName)
                         throws java.lang.Exception

Execute the job. NOTE: in the quartz implementation, the value of the jobName parameter should be the trigger name associated with the job to be executed.

Parameters:

jobName -

Returns:

Throws:

java.lang.Exception

deleteJob

IScheduledJob deleteJob(java.lang.String jobName)
                        throws java.lang.Exception

Delete the job. NOTE: in the quartz implementation, the value of the jobName parameter should be the trigger name associated with the job to be deleted.

Parameters:

jobName -

Returns:

Throws:

java.lang.Exception

scheduleJob

IScheduledJob scheduleJob(ISchedule schedule)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getSchedulerState

int getSchedulerState()
                      throws java.lang.Exception

Throws:

java.lang.Exception

pauseScheduler

void pauseScheduler()
                    throws java.lang.Exception

Throws:

java.lang.Exception

resumeScheduler

void resumeScheduler()
                     throws java.lang.Exception

Throws:

java.lang.Exception

getCronSummary

java.lang.String getCronSummary(java.lang.String cron)
                                throws java.lang.Exception

Throws:

java.lang.Exception