org.pentaho.platform.api.engine
Interface IScheduledJob

All Known Implementing Classes:

QuartzScheduledJob

public interface IScheduledJob

Field Summary

static int	STATE_BLOCKED A ScheduledJob arrives at the blocked state when the job that it is associated with is a StatefulJob and it is currently executing.
static int	STATE_COMPLETE The trigger has no remaining fire-times in its schedule.
static int	STATE_ERROR A ScheduledJob arrives at the error state when the scheduler attempts to fire it, but cannot due to an error creating and executing its related job.
static int	STATE_NONE Indicates that the ScheduledJob does not exist.
static int	STATE_NORMAL
static int	STATE_PAUSED

Method Summary

String	getDescription()
String	getErrorMessage()
int	getExecutionState()
Date	getLastTriggerTime()
Date	getNextTriggerTime()
String	getUniqueId()

Field Detail

STATE_NORMAL

static final int STATE_NORMAL

See Also:

Constant Field Values

STATE_PAUSED

static final int STATE_PAUSED

See Also:

Constant Field Values

STATE_COMPLETE

static final int STATE_COMPLETE

The trigger has no remaining fire-times in its schedule.

See Also:

Constant Field Values

STATE_ERROR

static final int STATE_ERROR

A ScheduledJob arrives at the error state when the scheduler attempts to fire it, but cannot due to an error creating and executing its related job. Often this is due to the Job's class not existing in the classpath.

When the ScheduledJob is in the error state, the scheduler will make no attempts to fire it.

See Also:

Constant Field Values

STATE_BLOCKED

static final int STATE_BLOCKED

A ScheduledJob arrives at the blocked state when the job that it is associated with is a StatefulJob and it is currently executing.

See Also:

StatefulJob, Constant Field Values

STATE_NONE

static final int STATE_NONE

Indicates that the ScheduledJob does not exist.

See Also:

Constant Field Values

Method Detail

getNextTriggerTime

Date getNextTriggerTime()

getLastTriggerTime

Date getLastTriggerTime()

getExecutionState

int getExecutionState()

getDescription

String getDescription()

getUniqueId

String getUniqueId()

getErrorMessage

String getErrorMessage()