A C E G I J O P R S T U X
All Classes All Packages

A

AbstractJob - Class in com.xpn.xwiki.plugin.scheduler

Base class for any XWiki Quartz Job.

AbstractJob() - Constructor for class com.xpn.xwiki.plugin.scheduler.AbstractJob

C

com.xpn.xwiki.plugin.scheduler - package com.xpn.xwiki.plugin.scheduler

E

ERROR_SCHEDULERPLUGIN_BAD_CRON_EXPRESSION - Static variable in exception com.xpn.xwiki.plugin.scheduler.SchedulerPluginException

ERROR_SCHEDULERPLUGIN_GET_SCHEDULER - Static variable in exception com.xpn.xwiki.plugin.scheduler.SchedulerPluginException

ERROR_SCHEDULERPLUGIN_INITIALIZE_STATUS_LISTENER - Static variable in exception com.xpn.xwiki.plugin.scheduler.SchedulerPluginException

ERROR_SCHEDULERPLUGIN_JOB_DOES_NOT_EXITS - Static variable in exception com.xpn.xwiki.plugin.scheduler.SchedulerPluginException

ERROR_SCHEDULERPLUGIN_JOB_XCLASS_NOT_FOUND - Static variable in exception com.xpn.xwiki.plugin.scheduler.SchedulerPluginException

ERROR_SCHEDULERPLUGIN_PAUSE_JOB - Static variable in exception com.xpn.xwiki.plugin.scheduler.SchedulerPluginException

ERROR_SCHEDULERPLUGIN_RESTORE_EXISTING_JOBS - Static variable in exception com.xpn.xwiki.plugin.scheduler.SchedulerPluginException

ERROR_SCHEDULERPLUGIN_RESTORE_JOB - Static variable in exception com.xpn.xwiki.plugin.scheduler.SchedulerPluginException

ERROR_SCHEDULERPLUGIN_RESUME_JOB - Static variable in exception com.xpn.xwiki.plugin.scheduler.SchedulerPluginException

ERROR_SCHEDULERPLUGIN_SAVE_JOB_CLASS - Static variable in exception com.xpn.xwiki.plugin.scheduler.SchedulerPluginException

ERROR_SCHEDULERPLUGIN_SCHEDULE_JOB - Static variable in exception com.xpn.xwiki.plugin.scheduler.SchedulerPluginException

ERROR_SCHEDULERPLUGIN_TRIGGER_JOB - Static variable in exception com.xpn.xwiki.plugin.scheduler.SchedulerPluginException

ERROR_SCHEDULERPLUGIN_UNABLE_TO_PREPARE_JOB_CONTEXT - Static variable in exception com.xpn.xwiki.plugin.scheduler.SchedulerPluginException

ERROR_SCHEDULERPLUGIN_UNABLE_TO_RETRIEVE_JOB - Static variable in exception com.xpn.xwiki.plugin.scheduler.SchedulerPluginException

execute(JobExecutionContext) - Method in class com.xpn.xwiki.plugin.scheduler.AbstractJob

executeJob(JobExecutionContext) - Method in class com.xpn.xwiki.plugin.scheduler.AbstractJob

executeJob(JobExecutionContext) - Method in class com.xpn.xwiki.plugin.scheduler.GroovyJob

Executes the Groovy script passed in the script property of the XWIKI_JOB_CLASS object extracted from the XWiki context passed in the Quartz's Job execution context.

G

getEvents() - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

getJobStatus(Object) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

getJobStatus(BaseObject) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

Return the trigger state as a $JobState, that holds both the integer trigger's inner value of the state and a String as a human readable representation of that state

getJobStatus(BaseObject, XWikiContext) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

Retrieve the job's status of a given XWIKI_JOB_CLASS job XObject, by asking the actual job status to the quartz scheduler instance.

getName() - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

getNextFireTime(Object) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

Give, for a XObject job in a JobState.STATE_NORMAL state, the next date at which the job will be executed, according to its cron expression.

getNextFireTime(BaseObject) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

getNextFireTime(BaseObject, XWikiContext) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

Get the next fire time for the given job name SchedulerJob

getPluginApi(XWikiPluginInterface, XWikiContext) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

getPreviousFireTime(Object) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

Give, for a XObject job in a JobState.STATE_NORMAL state, the previous date at which the job has been executed, the fire time is not computed from the CRON expression, this method will return null if the .

getPreviousFireTime(BaseObject) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

Give, for a BaseObject job in a JobState.STATE_NORMAL state, the previous date at which the job has been executed.

getPreviousFireTime(BaseObject, XWikiContext) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

Give, for a BaseObject job in a JobState.STATE_NORMAL state, the previous date at which the job has been executed.

getQuartzState() - Method in class com.xpn.xwiki.plugin.scheduler.JobState

getScheduler() - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

getState() - Method in class com.xpn.xwiki.plugin.scheduler.JobState

getStatus(Object) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

Return the trigger state of the given XWIKI_JOB_CLASS XObject job.

getValue() - Method in class com.xpn.xwiki.plugin.scheduler.JobState

getXWikiContext() - Method in class com.xpn.xwiki.plugin.scheduler.AbstractJob

GroovyJob - Class in com.xpn.xwiki.plugin.scheduler

The task that will get executed by the Scheduler when the Job is triggered.

GroovyJob() - Constructor for class com.xpn.xwiki.plugin.scheduler.GroovyJob

I

init(XWikiContext) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

J

JobState - Class in com.xpn.xwiki.plugin.scheduler

Wrapper around the Quartz trigger's inner state of a Scheduler Job.

JobState(int) - Constructor for class com.xpn.xwiki.plugin.scheduler.JobState

Deprecated.

JobState(Trigger.TriggerState) - Constructor for class com.xpn.xwiki.plugin.scheduler.JobState

O

onEvent(Event, Object, Object) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

P

pauseJob(Object) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

Pause the given XObject job by pausing all of its current triggers.

pauseJob(BaseObject) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

pauseJob(BaseObject, XWikiContext) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

Pause the job with the given name by pausing all of its current triggers.

R

resumeJob(Object) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

Resume a XObject job that is in a JobState.STATE_PAUSED state.

resumeJob(BaseObject) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

resumeJob(BaseObject, XWikiContext) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

Resume the job with the given name (un-pause)

S

scheduleJob(Object) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

Schedule the given XObject to be executed according to its parameters.

scheduleJob(BaseObject) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

scheduleJob(BaseObject, XWikiContext) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

scheduleJobs(Document) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

Schedule all XWIKI_JOB_CLASS XObjects stored inside the given Wiki document, according to each XObject own parameters.

SchedulerPlugin - Class in com.xpn.xwiki.plugin.scheduler

See SchedulerPluginApi for documentation.

SchedulerPlugin(String, String, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

Default plugin constructor.

SchedulerPluginApi - Class in com.xpn.xwiki.plugin.scheduler

A Scheduler plugin to plan execution of Jobs from XWiki with cron expressions.

SchedulerPluginApi(SchedulerPlugin, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

SchedulerPluginException - Exception in com.xpn.xwiki.plugin.scheduler

An exception that might be thrown when doing various tasks in the scheduler plugin.

SchedulerPluginException(int, String) - Constructor for exception com.xpn.xwiki.plugin.scheduler.SchedulerPluginException

SchedulerPluginException(int, String, Throwable) - Constructor for exception com.xpn.xwiki.plugin.scheduler.SchedulerPluginException

SchedulerPluginException(int, String, Throwable, Object[]) - Constructor for exception com.xpn.xwiki.plugin.scheduler.SchedulerPluginException

setQuartzState(Trigger.TriggerState) - Method in class com.xpn.xwiki.plugin.scheduler.JobState

setScheduler(Scheduler) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

setState(int) - Method in class com.xpn.xwiki.plugin.scheduler.JobState

Deprecated.

STATE_BLOCKED - Static variable in class com.xpn.xwiki.plugin.scheduler.JobState

STATE_COMPLETE - Static variable in class com.xpn.xwiki.plugin.scheduler.JobState

STATE_ERROR - Static variable in class com.xpn.xwiki.plugin.scheduler.JobState

STATE_NONE - Static variable in class com.xpn.xwiki.plugin.scheduler.JobState

STATE_NORMAL - Static variable in class com.xpn.xwiki.plugin.scheduler.JobState

STATE_PAUSED - Static variable in class com.xpn.xwiki.plugin.scheduler.JobState

T

triggerJob(Object) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

Trigger a XObject job (execute it now).

triggerJob(BaseObject) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

Trigger a BaseObject job (execute it now).

triggerJob(BaseObject, XWikiContext) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

Trigger a job (execute it now)

U

unscheduleJob(Object) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

Unschedule a XObject job by deleting it from the jobs table.

unscheduleJob(BaseObject) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPluginApi

unscheduleJob(BaseObject, XWikiContext) - Method in class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

Unschedule the given job

X

XWIKI_JOB_CLASS - Static variable in class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

Deprecated.

use XWIKI_JOB_CLASSREFERENCE instead

XWIKI_JOB_CLASSREFERENCE - Static variable in class com.xpn.xwiki.plugin.scheduler.SchedulerPlugin

Local reference of the XWiki Scheduler Job Class representing a job that can be scheduled by this plugin.

A C E G I J O P R S T U X
All Classes All Packages