Package org.activiti.engine.runtime

Interface ProcessInstance

All Superinterfaces:

Execution

All Known Subinterfaces:

ExecutionEntity

All Known Implementing Classes:

ExecutionEntityImpl

@Internal
public interface ProcessInstance
extends Execution

Represents one execution of a ProcessDefinition.

Method Summary

Modifier and Type	Method	Description
java.lang.Integer	getAppVersion()
java.lang.String	getBusinessKey()	The business key of this process instance.
java.lang.String	getDeploymentId()	The deployment id of the process definition of the process instance.
java.lang.String	getDescription()	Returns the description of this process instance.
java.lang.String	getLocalizedDescription()	Returns the localized description of this process instance.
java.lang.String	getLocalizedName()	Returns the localized name of this process instance.
java.lang.String	getName()	Returns the name of this process instance.
java.lang.String	getProcessDefinitionId()	The id of the process definition of the process instance.
java.lang.String	getProcessDefinitionKey()	The key of the process definition of the process instance.
java.lang.String	getProcessDefinitionName()	The name of the process definition of the process instance.
java.lang.Integer	getProcessDefinitionVersion()	The version of the process definition of the process instance.
java.util.Map<java.lang.String,java.lang.Object>	getProcessVariables()	Returns the process variables if requested in the process instance query
java.util.Date	getStartTime()	Returns the start time of this process instance.
java.lang.String	getStartUserId()	Returns the user id of this process instance.
java.lang.String	getTenantId()	The tenant identifier of this process instance
boolean	isSuspended()	returns true if the process instance is suspended
void	setAppVersion(java.lang.Integer appVersion)

Methods inherited from interface org.activiti.engine.runtime.Execution

getActivityId, getId, getParentId, getParentProcessInstanceId, getProcessInstanceId, getRootProcessInstanceId, getSuperExecutionId, isEnded

Method Detail

getProcessDefinitionId

java.lang.String getProcessDefinitionId()

The id of the process definition of the process instance.

getProcessDefinitionName

java.lang.String getProcessDefinitionName()

The name of the process definition of the process instance.

getProcessDefinitionKey

java.lang.String getProcessDefinitionKey()

The key of the process definition of the process instance.

getProcessDefinitionVersion

java.lang.Integer getProcessDefinitionVersion()

The version of the process definition of the process instance.

getDeploymentId

java.lang.String getDeploymentId()

The deployment id of the process definition of the process instance.

getBusinessKey

java.lang.String getBusinessKey()

The business key of this process instance.

isSuspended

boolean isSuspended()

returns true if the process instance is suspended

Specified by:

isSuspended in interface Execution

getProcessVariables

java.util.Map<java.lang.String,java.lang.Object> getProcessVariables()

Returns the process variables if requested in the process instance query

getTenantId

java.lang.String getTenantId()

The tenant identifier of this process instance

Specified by:

getTenantId in interface Execution

getName

java.lang.String getName()

Returns the name of this process instance.

Specified by:

getName in interface Execution

getDescription

java.lang.String getDescription()

Returns the description of this process instance.

Specified by:

getDescription in interface Execution

getLocalizedName

java.lang.String getLocalizedName()

Returns the localized name of this process instance.

getLocalizedDescription

java.lang.String getLocalizedDescription()

Returns the localized description of this process instance.

getStartTime

java.util.Date getStartTime()

Returns the start time of this process instance.

getStartUserId

java.lang.String getStartUserId()

Returns the user id of this process instance.

setAppVersion

void setAppVersion(java.lang.Integer appVersion)

getAppVersion

java.lang.Integer getAppVersion()