Package org.flowable.engine.impl.persistence.entity

Class HistoricProcessInstanceEntityImpl

java.lang.Object

org.flowable.common.engine.impl.persistence.entity.AbstractEntity

org.flowable.engine.impl.persistence.entity.AbstractBpmnEngineEntity

org.flowable.engine.impl.persistence.entity.HistoricScopeInstanceEntityImpl

org.flowable.engine.impl.persistence.entity.HistoricProcessInstanceEntityImpl

All Implemented Interfaces:

Serializable, HasRevision, Entity, HistoricProcessInstance, HistoricProcessInstanceEntity, HistoricScopeInstanceEntity

public class HistoricProcessInstanceEntityImpl
extends HistoricScopeInstanceEntityImpl
implements HistoricProcessInstanceEntity

Author:

Tom Baeyens, Christian Stettler, Joram Barrez

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	businessKey
protected String	businessStatus
protected String	callbackId
protected String	callbackType
protected String	deploymentId
protected String	description
protected String	endActivityId
protected String	localizedDescription
protected String	localizedName
protected String	name
protected String	processDefinitionCategory
protected String	processDefinitionKey
protected String	processDefinitionName
protected Integer	processDefinitionVersion
protected String	propagatedStageInstanceId
protected List<HistoricVariableInstanceEntity>	queryVariables
protected String	referenceId
protected String	referenceType
protected String	startActivityId
protected String	startUserId
protected String	superProcessInstanceId
protected String	tenantId

Fields inherited from class org.flowable.engine.impl.persistence.entity.HistoricScopeInstanceEntityImpl

deleteReason, durationInMillis, endTime, processDefinitionId, processInstanceId, startTime

Fields inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

id, isDeleted, isInserted, isUpdated, originalPersistentState, revision

Constructor Summary

Constructors

Constructor	Description
HistoricProcessInstanceEntityImpl()
HistoricProcessInstanceEntityImpl(ExecutionEntity processInstance)

Method Summary

Modifier and Type	Method	Description
String	getBusinessKey()	The user provided unique reference to this process instance.
String	getBusinessStatus()	The user provided business status for this process instance.
String	getCallbackId()	The callback id for the process instance.
String	getCallbackType()	The callback type for the process instance.
String	getDeploymentId()	The deployment id of the process definition of the process instance.
String	getDescription()	The description for the process instance.
String	getEndActivityId()	Reference to the activity in which this process instance ended.
String	getLocalizedDescription()
String	getLocalizedName()
String	getName()	The name for the process instance.
Object	getPersistentState()	Returns a representation of the object, as would be stored in the database.
String	getProcessDefinitionCategory()	The category of the process definition of the process instance.
String	getProcessDefinitionKey()	The key of the process definition of the process instance.
String	getProcessDefinitionName()	The name of the process definition of the process instance.
Integer	getProcessDefinitionVersion()	The version of the process definition of the process instance.
Map<String,Object>	getProcessVariables()	Returns the process variables if requested in the process instance query
String	getPropagatedStageInstanceId()	If this process instance runs in the context of a case and stage, this method returns it's closest parent stage instance id (the stage plan item instance id to be precise).
List<HistoricVariableInstanceEntity>	getQueryVariables()
String	getReferenceId()	The reference id for the process instance.
String	getReferenceType()	The reference type for the process instance.
String	getStartActivityId()	The start activity.
String	getStartUserId()	The authenticated user that started this process instance.
String	getSuperProcessInstanceId()	The process instance id of a potential super process instance or null if no super process instance exists
String	getTenantId()	The tenant identifier for the process instance.
void	setBusinessKey(String businessKey)
void	setBusinessStatus(String businessStatus)
void	setCallbackId(String callbackId)
void	setCallbackType(String callbackType)
void	setDeploymentId(String deploymentId)
void	setDescription(String description)
void	setEndActivityId(String endActivityId)
void	setLocalizedDescription(String localizedDescription)
void	setLocalizedName(String localizedName)
void	setName(String name)
void	setProcessDefinitionCategory(String processDefinitionCategory)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessDefinitionName(String processDefinitionName)
void	setProcessDefinitionVersion(Integer processDefinitionVersion)
void	setPropagatedStageInstanceId(String propagatedStageInstanceId)
void	setQueryVariables(List<HistoricVariableInstanceEntity> queryVariables)
void	setReferenceId(String referenceId)
void	setReferenceType(String referenceType)
void	setStartActivityId(String startUserId)
void	setStartUserId(String startUserId)
void	setSuperProcessInstanceId(String superProcessInstanceId)
void	setTenantId(String tenantId)
String	toString()

Methods inherited from class org.flowable.engine.impl.persistence.entity.HistoricScopeInstanceEntityImpl

getDeleteReason, getDurationInMillis, getEndTime, getProcessDefinitionId, getProcessInstanceId, getStartTime, markEnded, setDeleteReason, setDurationInMillis, setEndTime, setProcessDefinitionId, setProcessInstanceId, setStartTime

Methods inherited from class org.flowable.engine.impl.persistence.entity.AbstractBpmnEngineEntity

getIdPrefix

Methods inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

getId, getOriginalPersistentState, getRevision, getRevisionNext, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setRevision, setUpdated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.flowable.common.engine.impl.persistence.entity.Entity

getId, getIdPrefix, getOriginalPersistentState, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setUpdated

Methods inherited from interface org.flowable.common.engine.impl.db.HasRevision

getRevision, getRevisionNext, setRevision

Methods inherited from interface org.flowable.engine.history.HistoricProcessInstance

getDeleteReason, getDurationInMillis, getEndTime, getId, getProcessDefinitionId, getStartTime

Methods inherited from interface org.flowable.engine.impl.persistence.entity.HistoricScopeInstanceEntity

getDeleteReason, getDurationInMillis, getEndTime, getProcessDefinitionId, getProcessInstanceId, getStartTime, markEnded, setDeleteReason, setDurationInMillis, setEndTime, setProcessDefinitionId, setProcessInstanceId, setStartTime

Field Details

endActivityId

protected String endActivityId

businessKey

protected String businessKey

businessStatus

protected String businessStatus

startUserId

protected String startUserId

startActivityId

protected String startActivityId

superProcessInstanceId

protected String superProcessInstanceId

tenantId

protected String tenantId

name

protected String name

localizedName

protected String localizedName

description

protected String description

localizedDescription

protected String localizedDescription

processDefinitionKey

protected String processDefinitionKey

processDefinitionName

protected String processDefinitionName

processDefinitionVersion

protected Integer processDefinitionVersion

processDefinitionCategory

protected String processDefinitionCategory

deploymentId

protected String deploymentId

callbackId

protected String callbackId

callbackType

protected String callbackType

referenceId

protected String referenceId

referenceType

protected String referenceType

propagatedStageInstanceId

protected String propagatedStageInstanceId

queryVariables

protected List<HistoricVariableInstanceEntity> queryVariables

Constructor Details

HistoricProcessInstanceEntityImpl

public HistoricProcessInstanceEntityImpl()

HistoricProcessInstanceEntityImpl

public HistoricProcessInstanceEntityImpl(ExecutionEntity processInstance)

Method Details

getPersistentState

public Object getPersistentState()

Description copied from interface: Entity

Returns a representation of the object, as would be stored in the database. Used when deciding if updates have occurred to the object or not since it was last loaded.

Specified by:

getPersistentState in interface Entity

getEndActivityId

public String getEndActivityId()

Description copied from interface: HistoricProcessInstance

Reference to the activity in which this process instance ended. Note that a process instance can have multiple end events, in this case it might not be deterministic which activity id will be referenced here. Use a HistoricActivityInstanceQuery instead to query for end events of the process instance (use the activityTYpe attribute)

Specified by:

getEndActivityId in interface HistoricProcessInstance

setEndActivityId

public void setEndActivityId(String endActivityId)

Specified by:

setEndActivityId in interface HistoricProcessInstanceEntity

getBusinessKey

public String getBusinessKey()

Description copied from interface: HistoricProcessInstance

The user provided unique reference to this process instance.

Specified by:

getBusinessKey in interface HistoricProcessInstance

setBusinessKey

public void setBusinessKey(String businessKey)

Specified by:

setBusinessKey in interface HistoricProcessInstanceEntity

getBusinessStatus

public String getBusinessStatus()

Description copied from interface: HistoricProcessInstance

The user provided business status for this process instance.

Specified by:

getBusinessStatus in interface HistoricProcessInstance

setBusinessStatus

public void setBusinessStatus(String businessStatus)

Specified by:

setBusinessStatus in interface HistoricProcessInstanceEntity

getStartUserId

public String getStartUserId()

Description copied from interface: HistoricProcessInstance

The authenticated user that started this process instance.

Specified by:

getStartUserId in interface HistoricProcessInstance

See Also:

• IdentityService.setAuthenticatedUserId(String)

setStartUserId

public void setStartUserId(String startUserId)

Specified by:

setStartUserId in interface HistoricProcessInstanceEntity

getStartActivityId

public String getStartActivityId()

Description copied from interface: HistoricProcessInstance

The start activity.

Specified by:

getStartActivityId in interface HistoricProcessInstance

setStartActivityId

public void setStartActivityId(String startUserId)

Specified by:

setStartActivityId in interface HistoricProcessInstanceEntity

getSuperProcessInstanceId

public String getSuperProcessInstanceId()

Description copied from interface: HistoricProcessInstance

The process instance id of a potential super process instance or null if no super process instance exists

Specified by:

getSuperProcessInstanceId in interface HistoricProcessInstance

setSuperProcessInstanceId

public void setSuperProcessInstanceId(String superProcessInstanceId)

Specified by:

setSuperProcessInstanceId in interface HistoricProcessInstanceEntity

getTenantId

public String getTenantId()

Description copied from interface: HistoricProcessInstance

The tenant identifier for the process instance.

Specified by:

getTenantId in interface HistoricProcessInstance

setTenantId

public void setTenantId(String tenantId)

Specified by:

setTenantId in interface HistoricProcessInstanceEntity

getName

public String getName()

Description copied from interface: HistoricProcessInstance

The name for the process instance.

Specified by:

getName in interface HistoricProcessInstance

setName

public void setName(String name)

Specified by:

setName in interface HistoricProcessInstanceEntity

getLocalizedName

public String getLocalizedName()

setLocalizedName

public void setLocalizedName(String localizedName)

Specified by:

setLocalizedName in interface HistoricProcessInstanceEntity

getDescription

public String getDescription()

Description copied from interface: HistoricProcessInstance

The description for the process instance.

Specified by:

getDescription in interface HistoricProcessInstance

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface HistoricProcessInstanceEntity

getLocalizedDescription

public String getLocalizedDescription()

setLocalizedDescription

public void setLocalizedDescription(String localizedDescription)

Specified by:

setLocalizedDescription in interface HistoricProcessInstanceEntity

getProcessDefinitionKey

public String getProcessDefinitionKey()

Description copied from interface: HistoricProcessInstance

The key of the process definition of the process instance.

Specified by:

getProcessDefinitionKey in interface HistoricProcessInstance

setProcessDefinitionKey

public void setProcessDefinitionKey(String processDefinitionKey)

Specified by:

setProcessDefinitionKey in interface HistoricProcessInstanceEntity

getProcessDefinitionName

public String getProcessDefinitionName()

Description copied from interface: HistoricProcessInstance

The name of the process definition of the process instance.

Specified by:

getProcessDefinitionName in interface HistoricProcessInstance

setProcessDefinitionName

public void setProcessDefinitionName(String processDefinitionName)

Specified by:

setProcessDefinitionName in interface HistoricProcessInstanceEntity

getProcessDefinitionVersion

public Integer getProcessDefinitionVersion()

Description copied from interface: HistoricProcessInstance

The version of the process definition of the process instance.

Specified by:

getProcessDefinitionVersion in interface HistoricProcessInstance

setProcessDefinitionVersion

public void setProcessDefinitionVersion(Integer processDefinitionVersion)

Specified by:

setProcessDefinitionVersion in interface HistoricProcessInstanceEntity

getProcessDefinitionCategory

public String getProcessDefinitionCategory()

Description copied from interface: HistoricProcessInstance

The category of the process definition of the process instance.

Specified by:

getProcessDefinitionCategory in interface HistoricProcessInstance

setProcessDefinitionCategory

public void setProcessDefinitionCategory(String processDefinitionCategory)

Specified by:

setProcessDefinitionCategory in interface HistoricProcessInstanceEntity

getDeploymentId

public String getDeploymentId()

Description copied from interface: HistoricProcessInstance

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

Specified by:

getDeploymentId in interface HistoricProcessInstance

setDeploymentId

public void setDeploymentId(String deploymentId)

Specified by:

setDeploymentId in interface HistoricProcessInstanceEntity

getCallbackId

public String getCallbackId()

Description copied from interface: HistoricProcessInstance

The callback id for the process instance.

Specified by:

getCallbackId in interface HistoricProcessInstance

setCallbackId

public void setCallbackId(String callbackId)

Specified by:

setCallbackId in interface HistoricProcessInstanceEntity

getCallbackType

public String getCallbackType()

Description copied from interface: HistoricProcessInstance

The callback type for the process instance.

Specified by:

getCallbackType in interface HistoricProcessInstance

setCallbackType

public void setCallbackType(String callbackType)

Specified by:

setCallbackType in interface HistoricProcessInstanceEntity

getReferenceId

public String getReferenceId()

Description copied from interface: HistoricProcessInstance

The reference id for the process instance.

Specified by:

getReferenceId in interface HistoricProcessInstance

setReferenceId

public void setReferenceId(String referenceId)

Specified by:

setReferenceId in interface HistoricProcessInstanceEntity

getReferenceType

public String getReferenceType()

Description copied from interface: HistoricProcessInstance

The reference type for the process instance.

Specified by:

getReferenceType in interface HistoricProcessInstance

setReferenceType

public void setReferenceType(String referenceType)

Specified by:

setReferenceType in interface HistoricProcessInstanceEntity

getPropagatedStageInstanceId

public String getPropagatedStageInstanceId()

Description copied from interface: HistoricProcessInstance

If this process instance runs in the context of a case and stage, this method returns it's closest parent stage instance id (the stage plan item instance id to be precise).

Specified by:

getPropagatedStageInstanceId in interface HistoricProcessInstance

Returns:

the stage instance id this process instance belongs to or null, if it is not part of a case at all or is not a child element of a stage

setPropagatedStageInstanceId

public void setPropagatedStageInstanceId(String propagatedStageInstanceId)

Specified by:

setPropagatedStageInstanceId in interface HistoricProcessInstanceEntity

getProcessVariables

public Map<String,Object> getProcessVariables()

Description copied from interface: HistoricProcessInstance

Returns the process variables if requested in the process instance query

Specified by:

getProcessVariables in interface HistoricProcessInstance

getQueryVariables

public List<HistoricVariableInstanceEntity> getQueryVariables()

Specified by:

getQueryVariables in interface HistoricProcessInstanceEntity

setQueryVariables

public void setQueryVariables(List<HistoricVariableInstanceEntity> queryVariables)

Specified by:

setQueryVariables in interface HistoricProcessInstanceEntity

toString

public String toString()

Overrides:

toString in class Object