com.atlassian.scheduler.core

Interface RunningJob

All Superinterfaces:

JobRunnerRequest

All Known Implementing Classes:

RunningJobImpl

public interface RunningJob
extends JobRunnerRequest

Represents a particular instance of a running job.

This adds management capabilities to a job runner request.

Since:

v1.3

Method Summary

Modifier and Type	Method and Description
void	cancel() Requests that the job be cancelled.

Methods inherited from interface com.atlassian.scheduler.JobRunnerRequest

getJobConfig, getJobId, getStartTime, isCancellationRequested

Method Detail

cancel

void cancel()

Requests that the job be cancelled.

Calling this method changes the return value of JobRunnerRequest.isCancellationRequested() permanently to true. It has no other effect; in particular, it does not interrupt the thread that is running the job. It is the responsibility of the job runner implementation to cooperatively check for an respond to the JobRunnerRequest.isCancellationRequested() flag.