All Superinterfaces:

IActivity, org.eclipse.core.runtime.IAdaptable

All Known Subinterfaces:

IWorkflowProcessModelVersion
```
public interface IProcessModelVersion
extends IActivity, org.eclipse.core.runtime.IAdaptable
```
IProcessModelVersion allows access to information about a version of a process model

Version:

06.11.2003 pk: added getPagesDirectory() and getDataDirectory(), 31.10.2003 ReW created

API:

This is a public API.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`activateRequiredProcessModelVersions()`	Activates this and all required process model versions.
`ILibrary`	`createLibrary(String id, int majorVersion)`	Deprecated. use `createLibrary(String, QualifiedVersion)` instead.
`ILibrary`	`createLibrary(String id, QualifiedVersion version)`
`void`	`deactivateDependentProcessModelVersions()`	Deactivates this and all depending process model versions.
`void`	`delete()`	Sets the release state of this process model version to DELETED.
`void`	`deleteLibrary()`	Deletes the library
`IApplication`	`getApplication()`	Gets the application this version belongs to.
`String`	`getDescription()`	Returns the description
`long`	`getId()`	Gets the identifier of the process model version
`ActivityState`	`getInheritedActivityState()`	Gets the inherited activity state.
`String`	`getLastChangeBy()`	Gets the user name who has lastly changed the version
`Date`	`getLastChangeDate()`	Gets the date the version was lastly changed
`String`	`getLastChangeFromHost()`	Gets the host name where the last change of the version was uploaded from
`ILibrary`	`getLibrary()`	Gets the library for which this pmv holds the data
`String`	`getName()`	Returns the process model version name
`IProcessModel`	`getProcessModel()`	Gets the process model this version belongs to.
`org.eclipse.core.resources.IProject`	`getProject()`	Gets the project that contains all resources of this process model version
`String`	`getProjectDirectory()`	Gets the path of the project that belongs to this process model version.
`String`	`getProjectName()`	Gets the name of the project that contains all resources of this proces model version
`ReleaseState`	`getReleaseState()`	Returns the release state
`Date`	`getReleaseTimestamp()`	Gets the timestamp when the process model version was released
`Logger`	`getRuntimeLog(RuntimeLogCategory category)`	Gets the runtime log logger for the process model version
`String`	`getVersionName()`	Returns the process model name inclusive the version number s used in urls e.g.
`int`	`getVersionNumber()`	Returns the version number
`boolean`	`isRequired()`	Tests if this process model version is required by other process model versions.
`void`	`release()`	Sets the release state of this process model version to released.
`void`	`release(Date dateTimeOfRelease)`	Sets the release state of this process model version at the specified date and time to RELEASED.

Methods inherited from interface ch.ivyteam.ivy.application.IActivity
activate, deactivate, getActivityOperationState, getActivityState, lock

- 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.
    
    Security:
    
    SESSION OWNS ProcessModelVersionReadName PERMISSION OR OWNS ProcessModelVersionReadName@SYSTEM PERMISSION
  - 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.
    
    Security:
    
    SESSION OWNS ProcessModelVersionReadVersionName PERMISSION OR OWNS ProcessModelVersionReadVersionName@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 ProcessModelVersionReadDescription PERMISSION OR OWNS ProcessModelVersionReadDescription@SYSTEM PERMISSION
  - 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.
    
    Security:
    
    SESSION OWNS ProcessModelVersionReadVersionNumber PERMISSION OR OWNS ProcessModelVersionReadVersionNumber@SYSTEM PERMISSION
  - 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.
    
    Security:
    
    SESSION OWNS ProcessModelVersionReadReleaseState PERMISSION OR OWNS ProcessModelVersionReadReleaseState@SYSTEM PERMISSION
  - 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.
    
    Security:
    
    SESSION OWNS ProcessModelVersionReadReleaseTimestamp PERMISSION OR OWNS ProcessModelVersionReadReleaseTimestamp@SYSTEM PERMISSION
  - 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.
    
    Security:
    
    SESSION OWNS ProcessModelVersionReadLastChangeDate PERMISSION OR OWNS ProcessModelVersionReadLastChangeDate@SYSTEM PERMISSION
  - 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.
    
    Security:
    
    SESSION OWNS ProcessModelVersionReadLastChangeBy PERMISSION OR OWNS ProcessModelVersionReadLastChangeBy@SYSTEM PERMISSION
  - 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.
    
    Security:
    
    SESSION OWNS ProcessModelVersionReadLastChangeFromHost PERMISSION OR OWNS ProcessModelVersionReadLastChangeFromHost@SYSTEM PERMISSION
  - 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.
    
    Security:
    
    SESSION OWNS ProcessModelRead PERMISSION OR OWNS ProcessModelRead@SYSTEM PERMISSION
  - 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.
    
    Security:
    
    SESSION OWNS ApplicationRead PERMISSION OR OWNS ApplicationRead@SYSTEM PERMISSION
  - 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.
    
    Security:
    
    SESSION OWNS ProcessModelVersionReadProjectDirectory PERMISSION OR OWNS ProcessModelVersionReadProjectDirectory@SYSTEM PERMISSION
  - 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.
    
    Security:
    
    SESSION OWNS ProcessModelVersionReadInheritedActivityState PERMISSION OR OWNS ProcessModelVersionReadInheritedActivityState@SYSTEM PERMISSION
  - 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.
    
    Security:
    
    SESSION OWNS ProjectRead PERMISSION OR OWNS ProjectRead@SYSTEM PERMISSION
  - 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.
    
    Security:
    
    SESSION OWNS ProjectReadName PERMISSION OR OWNS ProjectReadName@SYSTEM PERMISSION
  - 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.
    
    Security:
    
    SESSION OWNS LibraryRead PERMISSION OR OWNS LibraryRead@SYSTEM PERMISSION
  - createLibrary
```
@Deprecated
ILibrary createLibrary(String id,
                       int majorVersion)
```
    Deprecated.
    use createLibrary(String, QualifiedVersion) instead.
    
    Parameters:
    
    id - the identifier of the library
    
    majorVersion - 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.
  - 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.

Interface IProcessModelVersion

Method Summary

Methods inherited from interface ch.ivyteam.ivy.application.IActivity

Method Detail

getName

getVersionName

getDescription

getVersionNumber

getReleaseState

getReleaseTimestamp

getLastChangeDate

getLastChangeBy

getLastChangeFromHost

getProcessModel

getApplication

release

release

delete

isRequired

getProjectDirectory

getId

getInheritedActivityState

getRuntimeLog

getProject

getProjectName

getLibrary

createLibrary

createLibrary

deleteLibrary

activateRequiredProcessModelVersions

deactivateDependentProcessModelVersions