Package ch.ivyteam.ivy.workflow
Enum TaskState
- java.lang.Object
-
- java.lang.Enum<TaskState>
-
- ch.ivyteam.ivy.workflow.TaskState
-
- All Implemented Interfaces:
ch.ivyteam.ivy.persistence.IPersistentEnumeration
,Serializable
,Comparable<TaskState>
public enum TaskState extends Enum<TaskState> implements ch.ivyteam.ivy.persistence.IPersistentEnumeration
States of a workflow task- Since:
- 17.05.2006
- See Also:
ITask.getState()
,ITask
,ICase
,IWorkflowSession
- API:
- This is a public API.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CREATED
This is the initial state of the first task of a process/case.DELAYED
Initial state of a task for which a delay period was configured.DESTROYED
Final task state if a task was destroyed.DONE
Final task state if the task was successfully done.FAILED
Only system tasks are in this state.JOIN_FAILED
A task in this state has run into an error during the joining of the task.JOINING
If all input tasks of a task switch process element have been reached then the state of all input tasks are set to theJOINING
state.PARKED
LikeSUSPENDED
but task was exclusively reserved by a user for working on it later (seeIWorkflowSession.parkTask(ITask)
).READY_FOR_JOIN
RESUMED
A user is working on this task right now (seeIWorkflowSession.resumeTask(long)
).SUSPENDED
Initial task state of tasks that are not the first task of a process.UNASSIGNED
WAITING_FOR_INTERMEDIATE_EVENT
This is an initial state if the task is waiting for an intermediate event.ZOMBIE
A task is in this state if it was in stateCREATED
and then the session of the user that was working on the task reached the timeout.
-
-
-
Enum Constant Detail
-
CREATED
public static final TaskState CREATED
This is the initial state of the first task of a process/case. A user is currently working on this task.- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
READY_FOR_JOIN
public static final TaskState READY_FOR_JOIN
If a task reaches a task switch process element it changes its state fromRESUMED
orCREATED
to this state. The task stays in this state until all input tasks of a case at the task switch process element are in this state. Then the task state is switch toJOINING
.- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
JOINING
public static final TaskState JOINING
If all input tasks of a task switch process element have been reached then the state of all input tasks are set to theJOINING
state. Then the process data of all input tasks are merged to a single process data. This data is then used as start process data of the output tasks of the task switch process element. If the joining is finished the tasks are set to stateDONE
.- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
DELAYED
public static final TaskState DELAYED
Initial state of a task for which a delay period was configured. The task stays in this state until the delay period is over. The task then is set to stateSUSPENDED
.- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
SUSPENDED
public static final TaskState SUSPENDED
Initial task state of tasks that are not the first task of a process. Users that are activator of a task in this state can work on it. If so the task is set to stateRESUMED
. This state can also be reached again if task was reseted (seeITask.reset()
).- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
RESUMED
public static final TaskState RESUMED
A user is working on this task right now (seeIWorkflowSession.resumeTask(long)
). This task is not the first task of a process (seeCREATED
). If the task ends on a process end the state is set toDONE
. If the task ends on a task switch process element it is set toREADY_FOR_JOIN
. If the user session reaches a timeout then the task is reset to stateSUSPENDED
. If the task is actively reseted by the working user or administrator (seeITask.reset()
).- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
DONE
public static final TaskState DONE
Final task state if the task was successfully done.- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
DESTROYED
public static final TaskState DESTROYED
Final task state if a task was destroyed. A user can manually destroy a task (seeITask.destroy()
). A task can be destroyed because of an expiry timeout.- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
PARKED
public static final TaskState PARKED
LikeSUSPENDED
but task was exclusively reserved by a user for working on it later (seeIWorkflowSession.parkTask(ITask)
). If user works on this task again state changes toSUSPENDED
. If task is reseted state changes also toSUSPENDED
(seeITask.reset()
).- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
UNASSIGNED
public static final TaskState UNASSIGNED
LikeSUSPENDED
but the task is not assigned to a user or role (meansITask.getActivator()
isnull
). If the task is reassigned by an administrator (seeITask.setActivator(ISecurityMember)
) to a user or role the state is set back toSUSPENDED
.- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
FAILED
public static final TaskState FAILED
Only system tasks are in this state. The execution of the system task has run into an error. Depending on configuration this is a final state or after a timeout the task is set back toSUSPENDED
to retry the execution.- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
JOIN_FAILED
public static final TaskState JOIN_FAILED
A task in this state has run into an error during the joining of the task. The task stays in this state until a timeout sets it back toREADY_FOR_JOIN
. The system will then retry to join the task.- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
WAITING_FOR_INTERMEDIATE_EVENT
public static final TaskState WAITING_FOR_INTERMEDIATE_EVENT
This is an initial state if the task is waiting for an intermediate event. Only system tasks can be in this state. If the intermediate event occurs the task is set to stateSUSPENDED
so that it is executed by the system.- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
-