Package ch.tocco.nice2.tasks.api.quartz

Interface TaskSchedulingService

All Known Implementing Classes:

TaskSchedulingServiceImpl

public interface TaskSchedulingService

Service to manually schedule AbstractJob tasks.

See Also:

• BatchJobManager

Field Summary

Fields

Modifier and Type	Field	Description
static final int	HIGH_LISTENER_PRIORITY
static final int	LOW_LISTENER_PRIORITY
static final int	NORMAL_LISTENER_PRIORITY

Method Summary

Modifier and Type	Method	Description
void	cancelJob(Entity taskExecution)	Interrupt a running job.
void	cancelJob(org.quartz.JobKey jobKey)	Interrupt a running job.
Optional<org.quartz.JobKey>	executeJobImmediately(Class<? extends AbstractJob> jobClass, String taskName, CallableType taskType, JobDataMapBuilder jobData)	Schedule a task which will be executed immediately (unless all threads are already occupied).
void	removeScheduledJob(Entity taskExecution)	Remove a scheduled job.
void	rescheduleJob(Entity taskExecution, org.joda.time.DateTime newDate)	Change the scheduled start time of a given job.
Optional<org.quartz.JobKey>	scheduleJob(Class<? extends AbstractJob> jobClass, String taskName, CallableType taskType, JobDataMapBuilder jobData, org.joda.time.DateTime executionDate)	Schedule a task to be executed at a specific date and time.

Field Details

HIGH_LISTENER_PRIORITY

static final int HIGH_LISTENER_PRIORITY

See Also:

• Constant Field Values

NORMAL_LISTENER_PRIORITY

static final int NORMAL_LISTENER_PRIORITY

See Also:

• Constant Field Values

LOW_LISTENER_PRIORITY

static final int LOW_LISTENER_PRIORITY

See Also:

• Constant Field Values

Method Details

executeJobImmediately

Optional<org.quartz.JobKey> executeJobImmediately(Class<? extends AbstractJob> jobClass,
 String taskName,
 CallableType taskType,
 JobDataMapBuilder jobData)

Schedule a task which will be executed immediately (unless all threads are already occupied).

Returns:

the JobKey if new job was scheduled (no new job is created if multiple schedules are disabled by setting JobDataMapBuilder.putMultipleSchedulesEnabled(boolean) to `false` and a job with the given `taskName` already exists)

scheduleJob

Optional<org.quartz.JobKey> scheduleJob(Class<? extends AbstractJob> jobClass,
 String taskName,
 CallableType taskType,
 JobDataMapBuilder jobData,
 org.joda.time.DateTime executionDate)

Schedule a task to be executed at a specific date and time.

Returns:

the JobKey if new job was scheduled (no new job is created if multiple schedules are disabled by setting JobDataMapBuilder.putMultipleSchedulesEnabled(boolean) to `false` and a job with the given `taskName` already exists)

cancelJob

void cancelJob(org.quartz.JobKey jobKey)

Interrupt a running job. The job must extend from AbstractInterruptableJob and must properly implement the cancellation.

Parameters:

jobKey - the key of the job

Throws:

CancellationNotSupportedException - if the referenced task is not interruptable

IllegalJobStateException - if no running job was found for that job key

JobAccessDeniedException - no permission to access the given job

cancelJob

void cancelJob(Entity taskExecution)

Interrupt a running job. The job must extend from AbstractInterruptableJob and must properly implement the cancellation.

Parameters:

taskExecution - the 'Task_execution' entity that represents the job to cancel

Throws:

CancellationNotSupportedException - if the referenced task is not interruptable

IllegalJobStateException - if no running job was found for that job key

JobAccessDeniedException - no permission to access the given job

removeScheduledJob

void removeScheduledJob(Entity taskExecution)

Remove a scheduled job.

Parameters:

taskExecution - the 'Task_execution' entity that represents the job to delete

Throws:

IllegalJobStateException - if the job has already started or is not found

JobAccessDeniedException - no permission to access the given job

rescheduleJob

void rescheduleJob(Entity taskExecution,
 org.joda.time.DateTime newDate)

Change the scheduled start time of a given job.

Parameters:

taskExecution - the 'Task_execution' entity that represents the job to reschedule

Throws:

IllegalJobStateException - if the job has already started or is not found

JobAccessDeniedException - no permission to access the given job