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 Details

    • 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()
      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.

    • getProcessElementId

      String getProcessElementId()
      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.

    • getTaskStarts

      List<ITaskStart> getTaskStarts()
      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.

    • getTaskEnds

      List<ITaskEnd> getTaskEnds()
      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.

    • findTaskSwitchEvents

      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 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 result
      count - the number of task switch events to return in the result
      returnAllCount - if true the query result method IQueryResult.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.

    • getKind

      TaskElementKind getKind()
      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.

    • getJoinPathes

      int getJoinPathes()
      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.

    • 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.