Package ch.ivyteam.ivy.workflow

Interface IWorkflowProcessModelVersion

All Superinterfaces:
IActivity, 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 Details

    • deleteStartEventElement

      @Deprecated(since="12.0.0", forRemoval=true) void deleteStartEventElement(String requestPath)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(since="12.0.0", forRemoval=true) List<IStartEventElement> getStartEventElements()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(since="12.0.0", forRemoval=true) IStartEventElement findStartEventElement(String requestPath)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(since="12.0.0", forRemoval=true) IProcessStart findProcessStart(String requestPath)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(since="12.0.0", forRemoval=true) void deleteStartElement(String requestPath)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(since="12.0.0", forRemoval=true) List<IStartElement> getStartElements()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(since="12.0.0", forRemoval=true) IStartElement findStartElement(String requestPath)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(since="12.0.0", forRemoval=true) IStartElement findStartElementByUserFriendlyRequestPath(String userFriendlyRequestPath)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(since="12.0.0", forRemoval=true) List<IProcessStart> getProcessStarts()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(since="12.0.0", forRemoval=true) IWorkflowContext getWorkflowContext()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(since="12.0.0", forRemoval=true) void deleteIntermediateEventElement(String processElementId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(since="12.0.0", forRemoval=true) List<IIntermediateEventElement> getIntermediateEventElements()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(since="12.0.0", forRemoval=true) IIntermediateEventElement findIntermediateEventElement(String processElementId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(since="12.0.0", forRemoval=true) List<ITaskElement> getTaskElements()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(since="12.0.0", forRemoval=true) List<ITaskElement> findTaskElements(EnumSet<TaskElementKind> taskElementKinds)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(since="12.0.0", forRemoval=true) Set<IWebServiceProcess> getWebServiceProcesses()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.