Package ch.ivyteam.ivy.application
Interface IProcessModel
- All Superinterfaces:
IActivity
- API:
- This is a public API.
-
Method Summary
Modifier and TypeMethodDescriptioncreateProcessModelVersion
(String name, String description, String projectName, int numberOfProcessElements, String createdByUser, String createdFromHost) Creates a new process model versioncreateProcessModelVersion
(String name, String description, String createdByUser, String createdFromHost, int version) Creates a new process model versionstatic IProcessModel
current()
Gets the current process model.findProcessModelVersion
(int versionNumber) Gets the process model version with the version numberfindProcessModelVersionByIdentifier
(long versionId) Gets the process model version with the given version idGets the web application this version belongs to.Returns the descriptionGets the file directory of the process modellong
getId()
Returns the process model identifierGets the inherited activity state.getName()
Returns the process model nameGets the process model versionsGets the process model version which is in state RELEASED.boolean
Checks if the process model can be deleted safely without throwing an exception.void
setDescription
(String description) Sets the descriptionMethods inherited from interface ch.ivyteam.ivy.application.IActivity
activate, deactivate, getActivityOperationState, getActivityState, lock
-
Method Details
-
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 Java.
-
getDescription
String getDescription()Returns the description- Returns:
- description
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
setDescription
Sets the description- Parameters:
description
- the description of the process model- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
- 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 Java.
-
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 versiondescription
- description of the versionprojectName
- name of the project that holds the resource of this process model version. Must be a unique name in the whole systemnumberOfProcessElements
- number of elements the version hascreatedByUser
- Name of the user who creates the versioncreatedFromHost
- 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 Java.
- 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 versiondescription
- description of the versioncreatedByUser
- Name of the user who creates the versioncreatedFromHost
- Name of the host from where the version is uploadedversion
- version of the process model to be created- Returns:
- new created process model version
- Throws:
PersistencyException
- if db access failsIllegalArgumentException
- if aIProcessModelVersion
withversion
already exists.- API:
- This public API is available in Java.
- 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 Java.
-
findProcessModelVersion
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 Java.
-
findProcessModelVersionByIdentifier
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 Java.
-
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 Java.
-
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 Java.
-
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 Java.
-
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 Java.
-
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:
- 9.2
- API:
- This public API is available in Java.
-
current
Gets the current process model.
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 or null if out of scope
- Since:
- 9.1
- API:
- This public API is available in Java.
-