Package com.polarion.platform.jobs.scheduler

Interface IJobSchedulerService

public interface IJobSchedulerService

Job scheduler service.

Runs jobs at certain times and intervals.

Version:

$Revision$ $Date$

Author:

Stepan Roh, Polarion Software

See Also:

• IJobService

Method Summary

Modifier and Type	Method	Description
Collection<JobSchedule>	getJobSchedules()	Return all scheduled jobs.
Collection<JobSchedule>	getJobSchedules(IContextId scope)	Return all scheduled jobs which have given scope.
boolean	isSchedulerRunning()	Whether the scheduler is running.
IJob	scheduleImmediately(JobExecutionRequest request)	Immediately schedule job for execution.
void	startScheduler()	Start scheduler.
void	stopScheduler()	Stop scheduler.

Method Details

startScheduler

void startScheduler()
             throws GenericJobException

Start scheduler.

Jobs which were scheduled at the time the scheduler was stopped ARE NOT executed out-of-order.

Scheduler is started after initialization.

Throws:

GenericJobException - if error occurs

stopScheduler

void stopScheduler()
            throws GenericJobException

Stop scheduler.

Throws:

GenericJobException - if error occurs.

isSchedulerRunning

boolean isSchedulerRunning()

Whether the scheduler is running.

Returns:

true if scheduler is running, false otherwise

getJobSchedules

Collection<JobSchedule> getJobSchedules()

Return all scheduled jobs.

Works even if the scheduler is stopped.

Returns:

Collection of JobSchedules (not null)

getJobSchedules

Collection<JobSchedule> getJobSchedules(IContextId scope)

Return all scheduled jobs which have given scope.

Works even if the scheduler is stopped.

Parameters:

scope - job scope (can be null)

Returns:

Collection of JobSchedules (not null)

scheduleImmediately

IJob scheduleImmediately(JobExecutionRequest request)
                  throws GenericJobException

Immediately schedule job for execution.

Job is both spawned (IJobManager.spawnJob(com.polarion.platform.jobs.IJobUnit, IJob)) and scheduled (IJob.schedule()).

Executed job will not be visible in getJobSchedules().

Parameters:

request - job execution request

Returns:

executed job (not null)

Throws:

GenericJobException - if error occurs

IllegalArgumentException - if request if null