Package ch.ivyteam.ivy.workflow

Interface IProcessStart

All Known Subinterfaces:

IStartElement, IStartEventElement, IStartSignalEventElement, IWebServiceProcessStartElement

public interface IProcessStart

ProcessStart allows access to statistic information about the cases and task that where started from this process start

Since:

17.05.2006

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the description (description you can specify at the process start element's start tab -> on field "Description")
String	getFullRequestPath()	Gets the request uri inclusive application and process model name
String	getFullUserFriendlyRequestPath()	Gets the user friendly request uri incl.
long	getId()	Gets the identifier of the process start
String	getName()	Returns the process start name (the name you specify at the process start element's start tab -> on field "Name")
String	getProcessElementId()	Gets the process element id of the process start
IWorkflowProcessModelVersion	getProcessModelVersion()	Gets the process model version
String	getRequestPath()	Gets the request path (only the "<process identifier>" + "/" + startXY.ivp)
ITaskStart	getTaskStart()	Gets the task start of this process start
String	getUserFriendlyRequestPath()	Gets the user friendly request path

Method Detail

getName

String getName()
        throws PersistencyException

Returns the process start name (the name you specify at the process start element's start tab -> on field "Name")

Returns:

name of process start

Throws:

PersistencyException - if persistency access fails

API:

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

Security:

SESSION OWNS TaskElementReadName PERMISSION OR OWNS TaskElementReadName@SYSTEM PERMISSION

getDescription

String getDescription()
               throws PersistencyException

Returns the description (description you can specify at the process start element's start tab -> on field "Description")

Returns:

description

Throws:

PersistencyException - if persistency access fails

API:

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

Security:

SESSION OWNS TaskElementReadDescription PERMISSION OR OWNS TaskElementReadDescription@SYSTEM PERMISSION

getRequestPath

String getRequestPath()
               throws PersistencyException

Gets the request path (only the "<process identifier>" + "/" + startXY.ivp)

Returns:

request path

Throws:

PersistencyException - if persistency access fails

API:

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

Security:

SESSION OWNS TaskStartReadStartRequestPath PERMISSION OR OWNS TaskStartReadStartRequestPath@SYSTEM PERMISSION

getUserFriendlyRequestPath

String getUserFriendlyRequestPath()
                           throws PersistencyException

Gets the user friendly request path

Returns:

user friendly request path

Throws:

PersistencyException - if persistency access fails

API:

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

Security:

SESSION OWNS TaskStartReadUserFriendlyStartRequestPath PERMISSION OR OWNS TaskStartReadUserFriendlyStartRequestPath@SYSTEM PERMISSION

getFullRequestPath

String getFullRequestPath()
                   throws PersistencyException

Gets the request uri inclusive application and process model name

Example: {application}/{process model}/{request path}

Returns:

full request path

Throws:

PersistencyException - if persistency access fails

API:

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

Security:

SESSION OWNS TaskStartReadStartRequestPath PERMISSION OR OWNS TaskStartReadStartRequestPath@SYSTEM PERMISSION

getFullUserFriendlyRequestPath

String getFullUserFriendlyRequestPath()
                               throws PersistencyException

Gets the user friendly request uri incl. application and process model name

Example: {application}/{process model}/{user friendly request path}

Returns:

full user friendly reqeust path

Throws:

PersistencyException - if persistency access fails

API:

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

Security:

SESSION OWNS TaskStartReadUserFriendlyStartRequestPath PERMISSION OR OWNS TaskStartReadUserFriendlyStartRequestPath@SYSTEM PERMISSION

getProcessModelVersion

IWorkflowProcessModelVersion getProcessModelVersion()
                                             throws PersistencyException

Gets the process model version

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

getId

long getId()

Gets the identifier of the process start

Returns:

identifier

API:

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

getProcessElementId

String getProcessElementId()
                    throws PersistencyException

Gets the process element id of the process start

Returns:

process element id

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

getTaskStart

ITaskStart getTaskStart()
                 throws PersistencyException

Gets the task start of this process start

Returns:

task start of this process start

Throws:

PersistencyException - if persistency access fails

API:

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