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 theIProcessModelVersion
interfaceIvyScript 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
All Methods Static Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description IIntermediateEventElement
createIntermediateEventElement(String requestPath, String userFriendlyRequestPath, String name, String description, String processElementId, String intermediateEventBeanClassName, String intermediateEventBeanConfiguration)
Creates an intermediate event elementIStartElement
createStartElement(String requestPath, String userFriendlyRequestPath, String activatorName, String name, String description, String processElementId, boolean isVisible)
IStartElement
createStartElement(String requestPath, String triggerSignature, String userFriendlyRequestPath, String activatorName, String name, String description, String processElementId, boolean isVisible, boolean persistOnStart)
IStartEventElement
createStartEventElement(String requestPath, String userFriendlyRequestPath, String name, String description, String processElementId, String eventBeanClassName, String eventBeanConfiguration)
void
deleteIntermediateEventElement(String processElementId)
Deletes an intermediate event elementvoid
deleteStartElement(String requestPath)
Deletes a start elementvoid
deleteStartEventElement(String requestPath)
Deletes a start event elementIIntermediateEventElement
findIntermediateEventElement(String processElementId)
Finds an intermedite event elementIProcessStart
findProcessStart(String requestPath)
Finds a process startIStartElement
findStartElement(String requestPath)
Finds a start elementIStartElement
findStartElementByUserFriendlyRequestPath(String userFriendlyRequestPath)
Finds a start element by its user friendly request pathIStartEventElement
findStartEventElement(String requestPath)
Finds a start event elementList<ITaskElement>
findTaskElements(EnumSet<TaskElementKind> taskElementKinds)
Finds task elements with the given task element kindsList<IIntermediateEventElement>
getIntermediateEventElements()
Gets all intermediate event elementsList<IProcessStart>
getProcessStarts()
Gets all process startsList<IStartElement>
getStartElements()
Gets all start elementsList<IStartEventElement>
getStartEventElements()
Gets all start event elementsList<ITaskElement>
getTaskElements()
Gets all task elementSet<IWebServiceProcess>
getWebServiceProcesses()
Gets all web service processes of this PMVIWorkflowContext
getWorkflowContext()
Gets the workflow contextstatic IWorkflowProcessModelVersion
of(IProcessModelVersion pmv)
Gets the @link IWorkflowProcessModelVersion} of the givenIProcessModelVersion
-
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, 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 Detail
-
createStartEventElement
@Deprecated IStartEventElement createStartEventElement(String requestPath, String userFriendlyRequestPath, String name, String description, String processElementId, String eventBeanClassName, String eventBeanConfiguration)
Deprecated.Creates a start event element- Parameters:
requestPath
- the request pathuserFriendlyRequestPath
- the user friendly request pathname
- the name of the start elementdescription
- the description of the start elementprocessElementId
- the identifier of the process elementeventBeanClassName
- Name of the event bean classeventBeanConfiguration
- Configuration of the event bean- Returns:
- the created start event element
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
- Security:
- SESSION OWNS StartEventElementCreate PERMISSION OR OWNS StartEventElementCreate@SYSTEM PERMISSION
-
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 IvyScript and Java. It has the visibility EXPERT.
- 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 IvyScript and Java. It has the visibility ADVANCED.
- Security:
- SESSION OWNS StartEventElementReadAll PERMISSION OR OWNS StartEventElementReadAll@SYSTEM PERMISSION
-
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 IvyScript and Java. It has the visibility EXPERT.
- Security:
- SESSION OWNS StartEventElementRead PERMISSION OR OWNS StartEventElementRead@SYSTEM PERMISSION
-
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 IvyScript and Java. It has the visibility EXPERT.
- Security:
- SESSION OWNS ProcessStartRead PERMISSION OR OWNS ProcessStartRead@SYSTEM PERMISSION
-
createStartElement
@Deprecated IStartElement createStartElement(String requestPath, String userFriendlyRequestPath, String activatorName, String name, String description, String processElementId, boolean isVisible)
Deprecated.- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
createStartElement
@Deprecated IStartElement createStartElement(String requestPath, String triggerSignature, String userFriendlyRequestPath, String activatorName, String name, String description, String processElementId, boolean isVisible, boolean persistOnStart)
Deprecated.- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
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 IvyScript and Java. It has the visibility EXPERT.
- 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 IvyScript and Java. It has the visibility EXPERT.
- Security:
- SESSION OWNS StartElementReadAll PERMISSION OR OWNS StartElementReadAll@SYSTEM PERMISSION
-
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 IvyScript and Java. It has the visibility EXPERT.
- Security:
- SESSION OWNS StartElementRead PERMISSION OR OWNS StartElementRead@SYSTEM PERMISSION
-
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 IvyScript and Java. It has the visibility EXPERT.
- Security:
- SESSION OWNS StartElementRead PERMISSION OR OWNS StartElementRead@SYSTEM PERMISSION
-
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 IvyScript and Java. It has the visibility EXPERT.
- Security:
- SESSION OWNS ProcessStartReadAll PERMISSION OR OWNS ProcessStartReadAll@SYSTEM PERMISSION
-
getWorkflowContext
IWorkflowContext getWorkflowContext()
Gets the workflow context- Returns:
- workflow context
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
createIntermediateEventElement
IIntermediateEventElement createIntermediateEventElement(String requestPath, String userFriendlyRequestPath, String name, String description, String processElementId, String intermediateEventBeanClassName, String intermediateEventBeanConfiguration)
Creates an intermediate event element- Parameters:
requestPath
- the request pathuserFriendlyRequestPath
- the user friendly request pathname
- the name of the intermediate event elementdescription
- the description of the intermediate event elementprocessElementId
- the identifier of the process elementintermediateEventBeanClassName
- Name of the intermediate event bean classintermediateEventBeanConfiguration
- 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 IvyScript and Java. It has the visibility EXPERT.
- Security:
- SESSION OWNS IntermediateEventElementCreate PERMISSION OR OWNS IntermediateEventElementCreate@SYSTEM PERMISSION
-
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 IvyScript and Java. It has the visibility EXPERT.
- 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 IvyScript and Java. It has the visibility ADVANCED.
- 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 IvyScript and Java. It has the visibility EXPERT.
- 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 IvyScript and Java. It has the visibility EXPERT.
-
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 IvyScript and Java. It has the visibility EXPERT.
-
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 IvyScript and Java. It has the visibility ADVANCED.
-
of
static IWorkflowProcessModelVersion of(IProcessModelVersion pmv)
Gets the @link IWorkflowProcessModelVersion} of the givenIProcessModelVersion
- Parameters:
pmv
-- Returns:
IWorkflowProcessModelVersion
of the givenIProcessModelVersion
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
-