Package ch.ivyteam.ivy.workflow

Interface ITaskStart

public interface ITaskStart

A place where tasks are started

Since:

18.07.2007

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
IQueryResult<ITask>	findStartedTasks(IPropertyFilter<TaskProperty> filter, List<PropertyOrder<TaskProperty>> order, int startIndex, int count, boolean returnAllCount)	Gets the tasks that were started from this task start
String	getFullStartRequestPath()	Gets the full request path to start a task on this task start with application name and process model version name
long	getId()	Gets the identifier
String	getStartRequestPath()	Gets the request path to start a task on this task start
ITaskElement	getTaskElement()	Gets the task element this task start belongs to
String	getUserFriendlyStartRequestPath()	Gets the user friendly start request path
boolean	isUsedByRunningTask()

Method Detail

getStartRequestPath

String getStartRequestPath()

Gets the request path to start a task on this task start

Returns:

start request path

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

Security:

SESSION OWNS TaskStartReadStartRequestPath PERMISSION OR OWNS TaskStartReadStartRequestPath@SYSTEM PERMISSION

getFullStartRequestPath

String getFullStartRequestPath()

Gets the full request path to start a task on this task start with application name and process model version name

Returns:

full start request path

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

Security:

SESSION OWNS TaskStartReadStartRequestPath PERMISSION OR OWNS TaskStartReadStartRequestPath@SYSTEM PERMISSION

getTaskElement

ITaskElement getTaskElement()

Gets the task element this task start belongs to

Returns:

task element

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

Security:

SESSION OWNS TaskElementRead PERMISSION OR OWNS TaskElementRead@SYSTEM PERMISSION

findStartedTasks

IQueryResult<ITask> findStartedTasks(IPropertyFilter<TaskProperty> filter,
                                     List<PropertyOrder<TaskProperty>> order,
                                     int startIndex,
                                     int count,
                                     boolean returnAllCount)

Gets the tasks that were started from this task start

Parameters:

filter - a filter to filter the returned tasks. Maybe null.

order - an order to order the returned tasks. Maybe null.

startIndex - the index of the first task of all tasks that is returned in the result

count - the number of tasks to return in the result

returnAllCount - if true the query result method IQueryResult.getAllCount() returns the overall cases that have been found, if false it returns -1

Returns:

a query result with the started tasks

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

Security:

SESSION OWNS TaskReadAll PERMISSION OR OWNS TaskReadAll@SYSTEM PERMISSION

getId

long getId()

Gets the identifier

Returns:

identifier

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

getUserFriendlyStartRequestPath

String getUserFriendlyStartRequestPath()

Gets the user friendly start request path

Returns:

user friendly start request path

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

Security:

SESSION OWNS TaskStartReadUserFriendlyStartRequestPath PERMISSION OR OWNS TaskStartReadUserFriendlyStartRequestPath@SYSTEM PERMISSION

isUsedByRunningTask

boolean isUsedByRunningTask()

Returns:

true, it the there are not ended tasks referenced with this task start.

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.