Package ch.ivyteam.ivy.application

Interface IProcessModel

  • All Superinterfaces:
    IActivity, org.eclipse.core.runtime.IAdaptable
    public interface IProcessModel
extends IActivity, org.eclipse.core.runtime.IAdaptable
    Interface IProcessModel supports access to information about IvyGrid Process Model
    API:
    This is a public API.

    • Method Detail

      • getName

        String getName()
        Returns the process model name
        Returns:
        name of process model
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.
        Security:
        SESSION OWNS ProcessModelReadName PERMISSION OR OWNS ProcessModelReadName@SYSTEM PERMISSION

      • getDescription

        String getDescription()
        Returns the description
        Returns:
        description
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.
        Security:
        SESSION OWNS ProcessModelReadDescription PERMISSION OR OWNS ProcessModelReadDescription@SYSTEM PERMISSION

      • setDescription

        void setDescription​(String description)
        Sets the description
        Parameters:
        description - the description of the process model
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.
        Security:
        SESSION OWNS ProcessModelWriteDescription PERMISSION OR OWNS ProcessModelWriteDescription@SYSTEM PERMISSION

      • getId

        long getId()
        Returns the process model identifier
        Returns:
        process model identifier
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • createProcessModelVersion

        IProcessModelVersion createProcessModelVersion​(String name,
                                               String description,
                                               String projectName,
                                               int numberOfProcessElements,
                                               String createdByUser,
                                               String createdFromHost)
        Creates a new process model version
        Parameters:
        name - name of the version
        description - description of the version
        projectName - name of the project that holds the resource of this process model version. Must be a unique name in the whole system
        numberOfProcessElements - number of elements the version has
        createdByUser - Name of the user who creates the version
        createdFromHost - Name of the host from where the version is uploaded
        Returns:
        new created process model version
        Throws:
        PersistencyException - if db access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.
        Security:
        SESSION OWNS ProcessModelVersionCreate PERMISSION OR OWNS ProcessModelVersionCreate@SYSTEM PERMISSION

      • createProcessModelVersion

        IProcessModelVersion createProcessModelVersion​(String name,
                                               String description,
                                               String createdByUser,
                                               String createdFromHost,
                                               int version)
        Creates a new process model version
        Parameters:
        name - name of the version
        description - description of the version
        createdByUser - Name of the user who creates the version
        createdFromHost - Name of the host from where the version is uploaded
        version - version of the process model to be created
        Returns:
        new created process model version
        Throws:
        PersistencyException - if db access fails
        IllegalArgumentException - if a IProcessModelVersion with version already exists.
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.
        Security:
        SESSION OWNS ProcessModelVersionCreate PERMISSION OR OWNS ProcessModelVersionCreate@SYSTEM PERMISSION

      • getProcessModelVersions

        List<IProcessModelVersion> getProcessModelVersions()
        Gets the process model versions
        Returns:
        unmodifiable list of process model versions
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.
        Security:
        SESSION OWNS ProcessModelVersionReadAll PERMISSION OR OWNS ProcessModelVersionReadAll@SYSTEM PERMISSION

      • findProcessModelVersion

        IProcessModelVersion findProcessModelVersion​(int versionNumber)
        Gets the process model version with the version number
        Parameters:
        versionNumber - the version number
        Returns:
        process model version or null if no version has this version number.
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.
        Security:
        SESSION OWNS ProcessModelVersionRead PERMISSION OR OWNS ProcessModelVersionRead@SYSTEM PERMISSION

      • findProcessModelVersionByIdentifier

        IProcessModelVersion findProcessModelVersionByIdentifier​(long versionId)
        Gets the process model version with the given version id
        Parameters:
        versionId - the version id
        Returns:
        process model version or null if no version has this id
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.
        Security:
        SESSION OWNS ProcessModelVersionRead PERMISSION OR OWNS ProcessModelVersionRead@SYSTEM PERMISSION

      • getReleasedProcessModelVersion

        IProcessModelVersion getReleasedProcessModelVersion()
        Gets the process model version which is in state RELEASED.
        Returns:
        process model version or null if no version is RELEASED.
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.
        Security:
        SESSION OWNS ProcessModelVersionRead PERMISSION OR OWNS ProcessModelVersionRead@SYSTEM PERMISSION

      • getFileDirectory

        String getFileDirectory()
        Gets the file directory of the process model
        Returns:
        file directory of the process model
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.
        Security:
        SESSION OWNS ProcessModelReadFileDirectory PERMISSION OR OWNS ProcessModelReadFileDirectory@SYSTEM PERMISSION

      • getApplication

        IApplication getApplication()
        Gets the web application this version belongs to.
        Returns:
        web application
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.
        Security:
        SESSION OWNS ApplicationRead PERMISSION OR OWNS ApplicationRead@SYSTEM PERMISSION

      • getInheritedActivityState

        ActivityState getInheritedActivityState()
        Gets the inherited activity state. This activity state is computed out of the application, process model and process model version activity state
        Returns:
        inherited activity state
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.
        Security:
        SESSION OWNS ProcessModelReadInheritedActivityState PERMISSION OR OWNS ProcessModelReadInheritedActivityState@SYSTEM PERMISSION

      • isDeletable

        boolean isDeletable()
        Checks if the process model can be deleted safely without throwing an exception. This can happen if the process model has process model versions with active dependent process model versions.
        Returns:
        true if process model can be deleted, false if not
        Since:
        8.0.12
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.