Package ch.ivyteam.ivy.workflow
Interface ITaskElement
-
public interface ITaskElement
A process element where tasks are started, ended or joined- Since:
- 18.07.2007
- API:
- This is a public API.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IQueryResult<ITaskSwitchEvent>
findTaskSwitchEvents(IPropertyFilter<TaskSwitchEventProperty> filter, List<PropertyOrder<TaskSwitchEventProperty>> order, int startIndex, int count, boolean returnAllCount)
Finds task switch events that were executed at this task elementString
getDescription()
Gets the descripion of the process elementlong
getId()
Gets the identifier of the task elementint
getJoinPathes()
Gets the number of tasks to join at this element.TaskElementKind
getKind()
The element kind of this task elementString
getName()
Gets the name of the process elementString
getProcessElementId()
Gets the process element identifierIWorkflowProcessModelVersion
getProcessModelVersion()
Gets the process model version this task element belongs toList<ITaskEnd>
getTaskEnds()
Gets the task ends that end at this elementList<ITaskStart>
getTaskStarts()
Gets the task starts that starts at this elementboolean
isUsedByRunningTask()
-
-
-
Method Detail
-
getId
long getId()
Gets the identifier of the task element- Returns:
- identifier
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
getProcessModelVersion
IWorkflowProcessModelVersion getProcessModelVersion() throws PersistencyException
Gets the process model version this task element belongs to- Returns:
- process model version
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
- Security:
- SESSION OWNS ProcessModelVersionRead PERMISSION OR OWNS ProcessModelVersionRead@SYSTEM PERMISSION
-
getProcessElementId
String getProcessElementId() throws PersistencyException
Gets the process element identifier- Returns:
- the process element identifier
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
- Security:
- SESSION OWNS TaskElementReadProcessElementId PERMISSION OR OWNS TaskElementReadProcessElementId@SYSTEM PERMISSION
-
getName
String getName() throws PersistencyException
Gets the name of the process element- Returns:
- name of the process element
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
- Security:
- SESSION OWNS TaskElementReadName PERMISSION OR OWNS TaskElementReadName@SYSTEM PERMISSION
-
getDescription
String getDescription() throws PersistencyException
Gets the descripion of the process element- Returns:
- description of the process element
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
- Security:
- SESSION OWNS TaskElementReadDescription PERMISSION OR OWNS TaskElementReadDescription@SYSTEM PERMISSION
-
getTaskStarts
List<ITaskStart> getTaskStarts() throws PersistencyException
Gets the task starts that starts at this element- Returns:
- list with the task starts
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
- Security:
- SESSION OWNS TaskStartReadAll PERMISSION OR OWNS TaskStartReadAll@SYSTEM PERMISSION
-
getTaskEnds
List<ITaskEnd> getTaskEnds() throws PersistencyException
Gets the task ends that end at this element- Returns:
- list with the task starts
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
- Security:
- SESSION OWNS TaskEndReadAll PERMISSION OR OWNS TaskEndReadAll@SYSTEM PERMISSION
-
findTaskSwitchEvents
IQueryResult<ITaskSwitchEvent> findTaskSwitchEvents(IPropertyFilter<TaskSwitchEventProperty> filter, List<PropertyOrder<TaskSwitchEventProperty>> order, int startIndex, int count, boolean returnAllCount) throws PersistencyException
Finds task switch events that were executed at this task element- Parameters:
filter
- a filter to filter the returned task switch events. Maybe null.order
- an order to order the returned task switch events. Maybe null.startIndex
- the index of the first task switch event of all task switch events that is returned in the resultcount
- the number of task switch events to return in the resultreturnAllCount
- if true the query result methodIQueryResult.getAllCount()
returns the overall task switch events that have been found, if false it returns -1- Returns:
- a query result with the task switch events
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
- Security:
- SESSION OWNS TaskSwitchEventReadAll PERMISSION OR OWNS TaskSwitchEventReadAll@SYSTEM PERMISSION
-
getKind
TaskElementKind getKind() throws PersistencyException
The element kind of this task element- Returns:
- element kind
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
- Security:
- SESSION OWNS TaskElementReadKind PERMISSION OR OWNS TaskElementReadKind@SYSTEM PERMISSION
-
getJoinPathes
int getJoinPathes() throws PersistencyException
Gets the number of tasks to join at this element. Start elements will return 0. End elements will return 1. Task Switch elements will return the number of their input arrows.- Returns:
- number of tasks to join
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
- Security:
- SESSION OWNS TaskElementReadJoinPathes PERMISSION OR OWNS TaskElementReadJoinPathes@SYSTEM PERMISSION
-
isUsedByRunningTask
boolean isUsedByRunningTask()
- Returns:
- true, it the there are not ended tasks referenced with this task element.
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
-