ScheduledJob (Atlassian Confluence 8.0.1 API)

All Known Subinterfaces:

ManagedScheduledJob

All Known Implementing Classes:

AbstractManagedScheduledJob, AbstractScheduledJob, ManagedScheduledCronJob, ManagedScheduledSimpleJob, ScheduledCronJob, ScheduledSimpleJob
```
public interface ScheduledJob
```
This is intended to be the interface for setting atlassian-scheduler jobs from Spring. See ScheduledCronJob and ScheduledSimpleJob.

Since:

5.10

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`com.atlassian.scheduler.config.JobConfig`	`getJobConfig()`	When scheduling the job, `ScheduleUtil.withTimeZone(JobConfig, TimeZone)` may be used to set the time zone in case the job is cron based.
`com.atlassian.scheduler.JobRunner`	`getJobRunner()`	The `JobRunnerKey` to register the `JobRunner` result of this method should be taken from the result of `getJobConfig()`.
`boolean`	`isClusteredOnly()`	Jobs that are only meaningful in clustered environment won't be scheduled in non-clustered environments.
`static com.atlassian.scheduler.config.JobId`	`sameJobId(ScheduledJob job)`	Utility to get `JobId` for the job, the same as the `JobRunnerKey` in the `JobConfig`.

- Method Detail
  - getJobRunner
```
com.atlassian.scheduler.JobRunner getJobRunner()
```
    The JobRunnerKey to register the JobRunner result of this method should be taken from the result of getJobConfig().
  - getJobConfig
```
com.atlassian.scheduler.config.JobConfig getJobConfig()
```
    When scheduling the job, ScheduleUtil.withTimeZone(JobConfig, TimeZone) may be used to set the time zone in case the job is cron based.
  - isClusteredOnly
```
boolean isClusteredOnly()
```
    Jobs that are only meaningful in clustered environment won't be scheduled in non-clustered environments.
  - sameJobId
```
static com.atlassian.scheduler.config.JobId sameJobId(ScheduledJob job)
```
    Utility to get JobId for the job, the same as the JobRunnerKey in the JobConfig.