Package ch.ivyteam.ivy.workflow

Interface ITaskEnd

public interface ITaskEnd

A place where a tasks are ended

Since:

18.07.2007

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
IQueryResult<ITask>	findEndedTasks(IPropertyFilter<TaskProperty> filter, List<PropertyOrder<TaskProperty>> order, int startIndex, int count, boolean returnAllCount)	Gets the tasks that ended on this task end
String	getFullJoinRequestPath()	Gets the full request path to join a task on this task start with application name and process model version name Returns null if this task end does not belong to a process model task switch element.
long	getId()	Gets the identifier
Integer	getJoinPathId()	Gets the join path id
String	getJoinRequestPath()	Gets the request path to join a task on a task switch element.
ITaskElement	getTaskElement()	Gets the task element this task end belongs to
boolean	isUsedByRunningTask()

Method Detail

getJoinRequestPath

String getJoinRequestPath()

Gets the request path to join a task on a task switch element. Returns null if this task end does not belong to a process model task switch element.

Returns:

join request path or null

API:

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

Security:

SESSION OWNS TaskEndReadJoinRequestPath PERMISSION OR OWNS TaskEndReadJoinRequestPath@SYSTEM PERMISSION

getFullJoinRequestPath

String getFullJoinRequestPath()

Gets the full request path to join a task on this task start with application name and process model version name Returns null if this task end does not belong to a process model task switch element.

Returns:

full join request path or null

API:

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

Security:

SESSION OWNS TaskEndReadFullJoinRequestPath PERMISSION OR OWNS TaskEndReadFullJoinRequestPath@SYSTEM PERMISSION

getTaskElement

ITaskElement getTaskElement()

Gets the task element this task end 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

findEndedTasks

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

Gets the tasks that ended on this task end

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

getJoinPathId

Integer getJoinPathId()

Gets the join path id

Returns:

join path id or null

API:

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

Security:

SESSION OWNS TaskEndReadJoinPathId PERMISSION OR OWNS TaskEndReadJoinPathId@SYSTEM PERMISSION

isUsedByRunningTask

boolean isUsedByRunningTask()

Returns:

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

API:

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