com.ibm.websphere.scheduler
Interface TaskStatus
- public interface TaskStatus
- extends java.io.Serializable
The Scheduler
interface has methods which allow modifying and
viewing a task that was created using the Scheduler.create(TaskInfo)
method.
Throughout the lifetime of a task, the status will change and it might be
useful to know what that state is.
A TaskStatus record that represents the current state can be obtained from various
Scheduler
methods, and can be specifically
queried using the Scheduler.getStatus(String)
method.
TaskStatus is a snapshot of the task's state and does not change. To retrieve the
current state of a task, the Scheduler.getStatus(String)
method must be re-run.
The getStatus()
method returns the current state of the task within its life cycle.
The method in which the TaskStatus was retrieved and the semantics of the task itself
determine if this state reflects the current state or the next effective state.
A task's normal life cycle, when using the quality of service
TaskInfo.QOS_ATLEASTONCE
or
the task execution option of TaskInfo.EXECUTION_DELAYEDUPDATE
, is:
SCHEDULED > RUNNING > COMPLETE
If a task is repeating:
SCHEDULED > RUNNING > SCHEDULED > RUNNING > ...
If a task is automatically purged:
SCHEDULED > RUNNING > INVALID
The SUSPENDED, CANCELLED and INVALID states can occur anytime during the task's life cycle.
If the task is using the default TaskInfo.QOS_ONLYONCE
quality of service, the RUNNING state is never used. The task always reflects the next effective state.
Field Summary
Modifier and Type | Field and Description |
---|---|
|
CANCELLED
The scheduled task has been cancelled using the
Scheduler.cancel method.
|
|
COMPLETE
The scheduled task has fired to completion.
|
|
INVALID
The scheduled task has been purged and is no longer valid.
|
|
RUNNING
The scheduled task is currently executing.
|
|
SCHEDULED
The scheduled task is currently scheduled to execute.
|
|
serialVersionUID
|
|
SUSPENDED
The scheduled task is suspended.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getName()
Get the name of the task.
|
|
getNextFireTime()
Get the date and time which this task is scheduled to fire next.
|
|
getRepeatsLeft()
Get the number of repeats that are left for this task.
|
|
getStatus()
Get the status of a task that is retrieved from a Scheduler.
|
|
getTaskId()
Get the task identifier for this task that was assigned when the task was created.
|
|
getTimeCreated()
Get the date and time which this task was originally created.
|
Field Detail
serialVersionUID
- static final long serialVersionUID
SCHEDULED
- static final int SCHEDULED
SUSPENDED
- static final int SUSPENDED
CANCELLED
- static final int CANCELLED
Scheduler.cancel
method.
The task will not fire and it cannot be resumed, but it can be purged.
COMPLETE
- static final int COMPLETE
RUNNING
- static final int RUNNING
INVALID
- static final int INVALID
Method Detail
getStatus
- int getStatus()
getTaskId
- java.lang.String getTaskId()
getName
- java.lang.String getName()
TaskInfo.setName
. getRepeatsLeft
- int getRepeatsLeft()
getNextFireTime
- java.util.Date getNextFireTime( )
getTimeCreated
- java.util.Date getTimeCreated()