Package ch.ivyteam.ivy.application

Interface IProcessModelVersion

  • All Superinterfaces:
    IActivity, org.eclipse.core.runtime.IAdaptable
    All Known Subinterfaces:
    IWorkflowProcessModelVersion
    public interface IProcessModelVersion
extends IActivity, org.eclipse.core.runtime.IAdaptable
    API:
    This is a public API.

    • Method Detail

      • getName

        String getName()
        Returns the process model version name
        Returns:
        name of process model version
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getVersionName

        String getVersionName()
        Returns the process model name inclusive the version number s used in urls e.g. "myProject$1"
        Returns:
        name of process model version
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

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

      • getVersionNumber

        int getVersionNumber()
        Returns the version number
        Returns:
        version number
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getReleaseState

        ReleaseState getReleaseState()
        Returns the release state
        Returns:
        release state
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getReleaseTimestamp

        Date getReleaseTimestamp()
        Gets the timestamp when the process model version was released
        Returns:
        timestamp or null if version was not yet released
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getLastChangeDate

        Date getLastChangeDate()
        Gets the date the version was lastly changed
        Returns:
        last change date
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getLastChangeBy

        String getLastChangeBy()
        Gets the user name who has lastly changed the version
        Returns:
        user name who has lastly changed the version
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getLastChangeFromHost

        String getLastChangeFromHost()
        Gets the host name where the last change of the version was uploaded from
        Returns:
        host name where the last change was uploaded from
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getProcessModel

        IProcessModel getProcessModel()
        Gets the process model this version belongs to.
        Returns:
        process model
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getApplication

        IApplication getApplication()
        Gets the application this version belongs to.
        Returns:
        application
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • release

        void release()
        Sets the release state of this process model version to released. The currently process model version in released state is set to release state deprecated. Precondition: The release state must be DEPRECATED, ARCHIVED or PREPARED.
        Throws:
        PersistencyException - if db access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.
        Security:
        SESSION OWNS ProcessModelVersionRelease PERMISSION OR OWNS ProcessModelVersionRelease@SYSTEM PERMISSION

      • release

        void release​(Date dateTimeOfRelease)
        Sets the release state of this process model version at the specified date and time to RELEASED. The currently process model version in released state will be set to release state deprecated then. Precondition: The release state must be DEPRECATED, ARCHIVED or PREPARED.
        Parameters:
        dateTimeOfRelease - at which date and time should the process model version set to RELEASED state.
        Throws:
        PersistencyException - if db access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.
        Security:
        SESSION OWNS ProcessModelVersionRelease PERMISSION OR OWNS ProcessModelVersionRelease@SYSTEM PERMISSION

      • delete

        void delete()
        Sets the release state of this process model version to DELETED. This method can only be called, if this process model version is no longer required by other PMV's. The later can be checked with a call to isRequired(). Precondition: The release state must be ARCHIVED or PREPARED and no other PMV's must be dependent on this PMV
        Throws:
        PersistencyException
        IllegalStateException - if not in state ARCHIVED or PREPARED or if required by other PMVs
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.
        Security:
        SESSION OWNS ProcessModelVersionDelete PERMISSION OR OWNS ProcessModelVersionDelete@SYSTEM PERMISSION

      • isRequired

        boolean isRequired()
        Tests if this process model version is required by other process model versions.
        Returns:
        true if other PMV's are dependent on this PMV, false otherwise
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getProjectDirectory

        String getProjectDirectory()
        Gets the path of the project that belongs to this process model version. The path can either locate a directory or a zip.
        Returns:
        the project directory
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getId

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

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

      • getRuntimeLog

        Logger getRuntimeLog​(RuntimeLogCategory category)
        Gets the runtime log logger for the process model version
        Parameters:
        category - the runtime log category
        Returns:
        the runtime log logger for the category
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getProject

        org.eclipse.core.resources.IProject getProject()
        Gets the project that contains all resources of this process model version
        Returns:
        resource project or null if no project is bound to pmv
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getProjectName

        String getProjectName()
        Gets the name of the project that contains all resources of this proces model version
        Returns:
        name of the project
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getLibrary

        ILibrary getLibrary()
        Gets the library for which this pmv holds the data
        Returns:
        library or null if this pmv does not hold data for a library
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • createLibrary

        ILibrary createLibrary​(String id,
                       QualifiedVersion version)
        Parameters:
        id - the identifier of the library
        version - the version of the library
        Returns:
        created library
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.
        Security:
        SESSION OWNS LibraryCreate PERMISSION OR OWNS LibraryCreate@SYSTEM PERMISSION

      • deleteLibrary

        void deleteLibrary()
        Deletes the library
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.
        Security:
        SESSION OWNS LibraryDelete PERMISSION OR OWNS LibraryDelete@SYSTEM PERMISSION

      • activateRequiredProcessModelVersions

        void activateRequiredProcessModelVersions()
        Activates this and all required process model versions.
        Throws:
        PersistencyException
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • deactivateDependentProcessModelVersions

        void deactivateDependentProcessModelVersions()
        Deactivates this and all depending process model versions.
        Throws:
        PersistencyException
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • current

        static IProcessModelVersion current()

        Gets the current process model version.

        Will return null if called out of scope. The scope is set if you call this method from an ivy process or any supported ivy environment. It is not set in non supported ivy environments (e.g. if you start your own threads, etc.).

        Returns:
        current process model version or null if out of scope
        Since:
        9.1
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • of

        static IProcessModelVersion of​(org.eclipse.core.resources.IProject project)
        Gets the current process model version of given project.
        Returns:
        process model version of given project
        Since:
        9.2.1
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.