Package ch.ivyteam.ivy.application
Interface IProcessModel
- All Superinterfaces:
IActivity
- API:
- This is a public API.
-
Method Summary
Modifier and TypeMethodDescriptionstatic 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.default String
Deprecated, for removal: This API element is subject to removal in a future version.Gets 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.default void
setDescription
(String description) Deprecated, for removal: This API element is subject to removal in a future version.Methods 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
Deprecated, for removal: This API element is subject to removal in a future version.Returns the description- Returns:
- description
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in Java.
-
setDescription
Deprecated, for removal: This API element is subject to removal in a future version.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.
-
getId
long getId()Returns the process model identifier- Returns:
- process model identifier
- API:
- This public API is available in Java.
-
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.
-