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- Version:
- 17.02.2004 pk: added findProcessModelVersionById(..), 31.10.2003 ReW most of the methods are moved to interface IProcessModelVersion. New method to create and get ProcessModelVersions, 20.1.2003 ReW methods create, delete, get StartWebServiceElement added, 4.9.2002 ReW added method findStartElement, 6.8.2002 ReW class renamed from Process to IProcessModel, 26.4.2002 ReW added methods for start event elements, 13.3.2001 ReW change Case methods because of the wf extension, 27.2.2001 ReW change to interface implementation move to class ProcessImpl, 4.12.2000 ReW field state and access methods added, 6.10.2000 ReW field numberOfElements added, 21.6.2000 ReW created
- API:
- This is a public API.
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description IProcessModelVersion
createProcessModelVersion(String name, String description, String projectName, int numberOfProcessElements, String createdByUser, String createdFromHost)
Creates a new process model versionIProcessModelVersion
createProcessModelVersion(String name, String description, String createdByUser, String createdFromHost, int version)
Creates a new process model versionstatic IProcessModel
current()
Gets the current process model.IProcessModelVersion
findProcessModelVersion(int versionNumber)
Gets the process model version with the version numberIProcessModelVersion
findProcessModelVersionByIdentifier(long versionId)
Gets the process model version with the given version idIApplication
getApplication()
Gets the web application this version belongs to.String
getDescription()
Returns the descriptionString
getFileDirectory()
Gets the file directory of the process modellong
getId()
Returns the process model identifierActivityState
getInheritedActivityState()
Gets the inherited activity state.String
getName()
Returns the process model nameList<IProcessModelVersion>
getProcessModelVersions()
Gets the process model versionsIProcessModelVersion
getReleasedProcessModelVersion()
Gets the process model version which is in state RELEASED.void
setDescription(String description)
Sets the description-
Methods inherited from interface ch.ivyteam.ivy.application.IActivity
activate, deactivate, getActivityOperationState, getActivityState, lock
-
-
-
-
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.
-
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.
-
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 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 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 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 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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
current
static IProcessModel 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 IvyScript and Java. It has the visibility EXPERT.
-
-