Package ch.ivyteam.ivy.workflow

Interface IWorkflowProcessModelVersion

All Superinterfaces:

IActivity, org.eclipse.core.runtime.IAdaptable, IProcessModelVersion

public interface IWorkflowProcessModelVersion
extends IProcessModelVersion

Workflow specific extension of the IProcessModelVersion interface

IvyScript Example:

import ch.ivyteam.ivy.workflow.IWorkflowProcessModelVersion;

IWorkflowProcessModelVersion pmv = IWorkflowProcessModelVersion.of(ivy.request.getProcessModelVersion());

Since:

23.07.2007

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
default IIntermediateEventElement	createIntermediateEventElement(String requestPath, String userFriendlyRequestPath, String name, String description, String processElementId, String intermediateEventBeanClassName, String intermediateEventBeanConfiguration)	Deprecated, for removal: This API element is subject to removal in a future version.
IStartElement	createStartElement(String requestPath, String triggerSignature, String userFriendlyRequestPath, String activatorName, String name, String description, String processElementId, boolean isVisible, boolean persistOnStart)	Deprecated, for removal: This API element is subject to removal in a future version. use createStartElement(String, String, String, String, String, String, CategoryPath, String, boolean, boolean, Map, List)
void	deleteIntermediateEventElement(String processElementId)	Deletes an intermediate event element
void	deleteStartElement(String requestPath)	Deletes a start element
void	deleteStartEventElement(String requestPath)	Deletes a start event element
IIntermediateEventElement	findIntermediateEventElement(String processElementId)	Finds an intermedite event element
IProcessStart	findProcessStart(String requestPath)	Finds a process start
IStartElement	findStartElement(String requestPath)	Finds a start element
IStartElement	findStartElementByUserFriendlyRequestPath(String userFriendlyRequestPath)	Finds a start element by its user friendly request path
IStartEventElement	findStartEventElement(String requestPath)	Finds a start event element
List<ITaskElement>	findTaskElements(EnumSet<TaskElementKind> taskElementKinds)	Finds task elements with the given task element kinds
List<IIntermediateEventElement>	getIntermediateEventElements()	Gets all intermediate event elements
List<IProcessStart>	getProcessStarts()	Gets all process starts
List<IStartElement>	getStartElements()	Gets all start elements
List<IStartEventElement>	getStartEventElements()	Gets all start event elements
List<ITaskElement>	getTaskElements()	Gets all task element
Set<IWebServiceProcess>	getWebServiceProcesses()	Gets all web service processes of this PMV
IWorkflowContext	getWorkflowContext()	Gets the workflow context
static IWorkflowProcessModelVersion	of(IProcessModelVersion pmv)	Gets the @link IWorkflowProcessModelVersion} of the given IProcessModelVersion

Methods inherited from interface ch.ivyteam.ivy.application.IActivity

activate, deactivate, getActivityOperationState, getActivityState, lock

Methods inherited from interface ch.ivyteam.ivy.application.IProcessModelVersion

activateRequiredProcessModelVersions, createLibrary, deactivateDependentProcessModelVersions, delete, deleteLibrary, getApplication, getDescription, getId, getInheritedActivityState, getLastChangeBy, getLastChangeDate, getLastChangeFromHost, getLibrary, getName, getProcessModel, getProject, getProjectDirectory, getProjectName, getReleaseState, getReleaseTimestamp, getRuntimeLog, getVersionName, getVersionNumber, isRequired, release, release

Method Details

deleteStartEventElement

void deleteStartEventElement(String requestPath)

Deletes a start event element

Parameters:

requestPath - the request path of the start element to delete

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

Security:

SESSION OWNS StartEventElementDelete PERMISSION OR OWNS StartEventElementDelete@SYSTEM PERMISSION

getStartEventElements

List<IStartEventElement> getStartEventElements()

Gets all start event elements

Returns:

unmodifiable list with all start elements

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

findStartEventElement

IStartEventElement findStartEventElement(String requestPath)

Finds a start event element

Parameters:

requestPath - the request path of the start element to find

Returns:

the start event element or null

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

findProcessStart

IProcessStart findProcessStart(String requestPath)

Finds a process start

Parameters:

requestPath - the request path of the start element

Returns:

the process start or null

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

createStartElement

@Deprecated(since="9.2",
            forRemoval=true)
IStartElement createStartElement(String requestPath,
 String triggerSignature,
 String userFriendlyRequestPath,
 String activatorName,
 String name,
 String description,
 String processElementId,
 boolean isVisible,
 boolean persistOnStart)

Deprecated, for removal: This API element is subject to removal in a future version.

use createStartElement(String, String, String, String, String, String, CategoryPath, String, boolean, boolean, Map, List)

API:

This public API is available in Java.

deleteStartElement

void deleteStartElement(String requestPath)

Deletes a start element

Parameters:

requestPath - the request path of the start element to delete

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

Security:

SESSION OWNS StartElementDelete PERMISSION OR OWNS StartElementDelete@SYSTEM PERMISSION

getStartElements

List<IStartElement> getStartElements()

Gets all start elements

Returns:

unmodifiable list with all start elements

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

findStartElement

IStartElement findStartElement(String requestPath)

Finds a start element

Parameters:

requestPath - the request path of the start element to find

Returns:

start element or null

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

findStartElementByUserFriendlyRequestPath

IStartElement findStartElementByUserFriendlyRequestPath(String userFriendlyRequestPath)

Finds a start element by its user friendly request path

Parameters:

userFriendlyRequestPath - the user friendly request path of the start element to find

Returns:

start element or null

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

getProcessStarts

List<IProcessStart> getProcessStarts()

Gets all process starts

Returns:

unmodifiable list with all process starts

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

getWorkflowContext

IWorkflowContext getWorkflowContext()

Gets the workflow context

Returns:

workflow context

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

createIntermediateEventElement

@Deprecated(since="11.2",
            forRemoval=true)
default IIntermediateEventElement createIntermediateEventElement(String requestPath,
 String userFriendlyRequestPath,
 String name,
 String description,
 String processElementId,
 String intermediateEventBeanClassName,
 String intermediateEventBeanConfiguration)

Deprecated, for removal: This API element is subject to removal in a future version.

Creates an intermediate event element

Parameters:

requestPath - the request path

userFriendlyRequestPath - the user friendly request path

name - the name of the intermediate event element

description - the description of the intermediate event element

processElementId - the identifier of the process element

intermediateEventBeanClassName - Name of the intermediate event bean class

intermediateEventBeanConfiguration - Configuration of the intermediate event bean

Returns:

the created intermediate event element

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

deleteIntermediateEventElement

void deleteIntermediateEventElement(String processElementId)

Deletes an intermediate event element

Parameters:

processElementId - the process element id of the intermediate event element to delete

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

Security:

SESSION OWNS IntermediateEventElementDelete PERMISSION OR OWNS IntermediateEventElementDelete@SYSTEM PERMISSION

getIntermediateEventElements

List<IIntermediateEventElement> getIntermediateEventElements()

Gets all intermediate event elements

Returns:

unmodifiable list with all intermediate event elements

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

Security:

SESSION OWNS IntermediateEventElementReadAll PERMISSION OR OWNS IntermediateEventElementReadAll@SYSTEM PERMISSION

findIntermediateEventElement

IIntermediateEventElement findIntermediateEventElement(String processElementId)

Finds an intermedite event element

Parameters:

processElementId - the process element id of the intermediate event element to find

Returns:

the intermediate event element or null

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

Security:

SESSION OWNS IntermediateEventElementRead PERMISSION OR OWNS IntermediateEventElementRead@SYSTEM PERMISSION

getTaskElements

List<ITaskElement> getTaskElements()

Gets all task element

Returns:

list wit all task element. Maybe empty. Never null.

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

findTaskElements

List<ITaskElement> findTaskElements(EnumSet<TaskElementKind> taskElementKinds)

Finds task elements with the given task element kinds

Parameters:

taskElementKinds - the task element kinds

Returns:

list with task elements. Maybe empty. Never null.

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

getWebServiceProcesses

Set<IWebServiceProcess> getWebServiceProcesses()

Gets all web service processes of this PMV

Returns:

unmodifiable set with all web service processes. Never null. Maybe empty.

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

of

static IWorkflowProcessModelVersion of(IProcessModelVersion pmv)

Gets the @link IWorkflowProcessModelVersion} of the given IProcessModelVersion

Parameters:

pmv -

Returns:

IWorkflowProcessModelVersion of the given IProcessModelVersion

API:

This public API is available in Java.