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.WorkflowNavigationUtil;
    import ch.ivyteam.ivy.workflow.IWorkflowProcessModelVersion;

    IWorkflowProcessModelVersion pmv;

    pmv = WorkflowNavigationUtil.getWorkflowProcessModelVersion(ivy.request.getProcessModelVersion());

    Since:
    23.07.2007
    API:
    This is a public API.

    • Method Detail

      • createStartEventElement

        @Deprecated
IStartEventElement createStartEventElement​(String requestPath,
                                           String userFriendlyRequestPath,
                                           String name,
                                           String description,
                                           String processElementId,
                                           String eventBeanClassName,
                                           String eventBeanConfiguration)
        Deprecated.
        use {createStartEventElement(String, String, String, String, String, String, String, String)
        Creates a start event element
        Parameters:
        requestPath - the request path
        userFriendlyRequestPath - the user friendly request path
        name - the name of the start element
        description - the description of the start element
        processElementId - the identifier of the process element
        eventBeanClassName - Name of the event bean class
        eventBeanConfiguration - 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.
        use createStartElement(String, String, String, String, String, String, String, boolean, boolean) instead
        Creates a start element
        Parameters:
        requestPath - the request path
        userFriendlyRequestPath - the user friendly request path
        activatorName - the activator that can start a process on this element
        name - the name of the start element
        description - the description of the start element
        processElementId - the process element identifier
        isVisible - is the start element visible
        Returns:
        the created start 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 StartElementCreate PERMISSION OR OWNS StartElementCreate@SYSTEM PERMISSION

      • createStartElement

        IStartElement createStartElement​(String requestPath,
                                 String triggerSignature,
                                 String userFriendlyRequestPath,
                                 String activatorName,
                                 String name,
                                 String description,
                                 String processElementId,
                                 boolean isVisible,
                                 boolean persistOnStart)
        Creates a start element
        Parameters:
        requestPath - the request path
        triggerSignature - the trigger Signature
        userFriendlyRequestPath - the user friendly request path
        activatorName - the activator that can start a process on this element
        name - the name of the start element
        description - the description of the start element
        processElementId - the process element identifier
        isVisible - is the start element visible
        persistOnStart -
        Returns:
        the created start 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 StartElementCreate PERMISSION OR OWNS StartElementCreate@SYSTEM PERMISSION

      • 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 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 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.
        Security:
        SESSION OWNS TaskElementRead PERMISSION OR OWNS TaskElementRead@SYSTEM PERMISSION

      • findTaskElement

        ITaskElement findTaskElement​(String processElementId)
        Finds task element with the given process element id
        Parameters:
        processElementId - the process element identifier of the task element to find
        Returns:
        task 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 TaskElementRead PERMISSION OR OWNS TaskElementRead@SYSTEM PERMISSION

      • 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.
        Security:
        SESSION OWNS TaskElementRead PERMISSION OR OWNS TaskElementRead@SYSTEM PERMISSION

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