org.apache.sling.event.jobs

Interface ScheduledJobInfo

@ProviderType
public interface ScheduledJobInfo

Information about a scheduled job

Since:

1.3

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getJobProperties() Return the optional job topics.
String	getJobTopic() Return the job topic.
Date	getNextScheduledExecution() Return the next scheduled execution date.
Collection<ScheduleInfo>	getSchedules() Get all schedules for this job
boolean	isSuspended() Is the processing currently suspended?
JobBuilder.ScheduleBuilder	reschedule() Reschedule this job with a new rescheduling information.
void	resume() Resume job processing.
void	suspend() Suspend this job scheduling.
void	unschedule() Unschedule this scheduled job.

Method Detail

getSchedules

Collection<ScheduleInfo> getSchedules()

Get all schedules for this job

Returns:

A non null and non empty list of schedules.

getNextScheduledExecution

Date getNextScheduledExecution()

Return the next scheduled execution date.

getJobTopic

String getJobTopic()

Return the job topic.

Returns:

The job topic

getJobProperties

Map<String,Object> getJobProperties()

Return the optional job topics.

Returns:

The job topics or null

unschedule

void unschedule()

Unschedule this scheduled job.

reschedule

JobBuilder.ScheduleBuilder reschedule()

Reschedule this job with a new rescheduling information. If rescheduling fails (due to wrong arguments), the job schedule is left as is.

suspend

void suspend()

Suspend this job scheduling. Job scheduling can be resumed with resume(). This information is persisted and survives a restart.

resume

void resume()

Resume job processing. suspend(). If the queue is not suspended, calling this method has no effect.

isSuspended

boolean isSuspended()

Is the processing currently suspended?