|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The current state of a scheduled task.
The Scheduler
object 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 may be
useful to know what that state is.
A TaskStatus object is returned with the current state using many of the
Scheduler
methods, and can be specifically
queried using the Scheduler.getStatus(String)
method.
This TaskStatus object 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 object 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.
Scheduler
Field Summary | |
---|---|
static int |
CANCELLED
The scheduled task has been cancelled using the Scheduler.cancel method. |
static int |
COMPLETE
The scheduled task has fired to completion. |
static int |
INVALID
The scheduled task has been purged and is no longer valid. |
static int |
RUNNING
The scheduled task is currently executing. |
static int |
SCHEDULED
The scheduled task is currently scheduled to execute. |
static long |
serialVersionUID
|
static int |
SUSPENDED
The scheduled task is suspended. |
Method Summary | |
---|---|
java.lang.String |
getName()
Get the name of the task. |
java.util.Date |
getNextFireTime()
Get the date and time which this task is scheduled to fire next. |
int |
getRepeatsLeft()
Get the number of repeats that are left for this task. |
int |
getStatus()
Get the status of a task that is retrieved from a Scheduler. |
java.lang.String |
getTaskId()
Get the task identifier for this task that was assigned when the task was created. |
java.util.Date |
getTimeCreated()
Get the date and time which this task was originally created. |
Field Detail |
public static final long serialVersionUID
public static final int SCHEDULED
public static final int SUSPENDED
Scheduler.suspend(java.lang.String)
,
Scheduler.resume(java.lang.String)
,
Constant Field Valuespublic static final int CANCELLED
Scheduler.cancel
method.
The task will not fire and it cannot be resumed, but it can be purged.
Scheduler.cancel(java.lang.String, boolean)
,
Scheduler.purge(java.lang.String)
,
Constant Field Valuespublic static final int COMPLETE
Scheduler.purge(java.lang.String)
,
TaskInfo.setAutoPurge(boolean)
,
TaskInfo.setNumberOfRepeats(int)
,
Constant Field Valuespublic static final int RUNNING
public static final int INVALID
Scheduler.purge(java.lang.String)
,
Constant Field ValuesMethod Detail |
public int getStatus()
Scheduler
public java.lang.String getTaskId()
Scheduler.create(com.ibm.websphere.scheduler.TaskInfo)
public java.lang.String getName()
TaskInfo.setName
.TaskInfo.setName(java.lang.String)
public int getRepeatsLeft()
public java.util.Date getNextFireTime()
public java.util.Date getTimeCreated()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |