org.flowable.compatibility.wrapper

Class Flowable5ProcessInstanceWrapper

java.lang.Object

org.flowable.compatibility.wrapper.Flowable5ProcessInstanceWrapper

All Implemented Interfaces:

Execution, ProcessInstance

public class Flowable5ProcessInstanceWrapper
extends Object
implements ProcessInstance

Wraps an v5 process instance to an v6 ProcessInstance.

Author:

Joram Barrez

Constructor Summary

Constructors

Constructor and Description
Flowable5ProcessInstanceWrapper(ProcessInstance activiti5ProcessInstance)

Method Summary

Modifier and Type	Method and Description
String	getActivityId() Returns the id of the activity where the execution currently is at.
String	getBusinessKey() The business key of this process instance.
String	getCallbackId() Returns the callback id of this process instance.
String	getCallbackType() Returns the callback type of this process instance.
String	getDeploymentId() The deployment id of the process definition of the process instance.
String	getDescription() Returns the description of this process instance.
String	getId() The unique identifier of the execution.
String	getLocalizedDescription() Returns the localized description of this process instance.
String	getLocalizedName() Returns the localized name of this process instance.
String	getName() Returns the name of this process instance.
String	getParentId() Gets the id of the parent of this execution.
String	getProcessDefinitionId() The id 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.
String	getProcessInstanceId() Id of the root of the execution tree representing the process instance.
Map<String,Object>	getProcessVariables() Returns the process variables if requested in the process instance query
String	getPropagatedStageInstanceId() If this execution 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).
ProcessInstance	getRawObject()
String	getReferenceId() If this execution has created a case (through a case task), this will return the referenced case instance id.
String	getReferenceType() If this execution has created a case (through a case task), this will return the referenced case type (e.g.
String	getRootProcessInstanceId() Id of the root of the execution tree representing the process instance that has no super execution.
Date	getStartTime() Returns the start time of this process instance.
String	getStartUserId() Returns the user id of this process instance.
String	getSuperExecutionId() Gets the id of the super execution of this execution.
String	getTenantId() The tenant identifier of this process instance
boolean	isEnded() Indicates if the execution is ended.
boolean	isSuspended() returns true if the process instance is suspended

Methods inherited from class java.lang.Object

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

Constructor Detail

Flowable5ProcessInstanceWrapper

public Flowable5ProcessInstanceWrapper(ProcessInstance activiti5ProcessInstance)

Method Detail

getId

public String getId()

Description copied from interface: Execution

The unique identifier of the execution.

Specified by:

getId in interface Execution

isEnded

public boolean isEnded()

Description copied from interface: Execution

Indicates if the execution is ended.

Specified by:

isEnded in interface Execution

getActivityId

public String getActivityId()

Description copied from interface: Execution

Returns the id of the activity where the execution currently is at. Returns null if the execution is not a 'leaf' execution (eg concurrent parent).

Specified by:

getActivityId in interface Execution

getProcessInstanceId

public String getProcessInstanceId()

Description copied from interface: Execution

Id of the root of the execution tree representing the process instance. It is the same as Execution.getId() if this execution is the process instance.

Specified by:

getProcessInstanceId in interface Execution

getRootProcessInstanceId

public String getRootProcessInstanceId()

Description copied from interface: Execution

Id of the root of the execution tree representing the process instance that has no super execution.

Specified by:

getRootProcessInstanceId in interface Execution

getParentId

public String getParentId()

Description copied from interface: Execution

Gets the id of the parent of this execution. If null, the execution represents a process-instance.

Specified by:

getParentId in interface Execution

getSuperExecutionId

public String getSuperExecutionId()

Description copied from interface: Execution

Gets the id of the super execution of this execution.

Specified by:

getSuperExecutionId in interface Execution

getProcessDefinitionId

public String getProcessDefinitionId()

Description copied from interface: ProcessInstance

The id of the process definition of the process instance.

Specified by:

getProcessDefinitionId in interface ProcessInstance

getProcessDefinitionName

public String getProcessDefinitionName()

Description copied from interface: ProcessInstance

The name of the process definition of the process instance.

Specified by:

getProcessDefinitionName in interface ProcessInstance

getProcessDefinitionKey

public String getProcessDefinitionKey()

Description copied from interface: ProcessInstance

The key of the process definition of the process instance.

Specified by:

getProcessDefinitionKey in interface ProcessInstance

getProcessDefinitionVersion

public Integer getProcessDefinitionVersion()

Description copied from interface: ProcessInstance

The version of the process definition of the process instance.

Specified by:

getProcessDefinitionVersion in interface ProcessInstance

getDeploymentId

public String getDeploymentId()

Description copied from interface: ProcessInstance

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

Specified by:

getDeploymentId in interface ProcessInstance

getBusinessKey

public String getBusinessKey()

Description copied from interface: ProcessInstance

The business key of this process instance.

Specified by:

getBusinessKey in interface ProcessInstance

isSuspended

public boolean isSuspended()

Description copied from interface: ProcessInstance

returns true if the process instance is suspended

Specified by:

isSuspended in interface Execution

Specified by:

isSuspended in interface ProcessInstance

getProcessVariables

public Map<String,Object> getProcessVariables()

Description copied from interface: ProcessInstance

Returns the process variables if requested in the process instance query

Specified by:

getProcessVariables in interface ProcessInstance

getTenantId

public String getTenantId()

Description copied from interface: ProcessInstance

The tenant identifier of this process instance

Specified by:

getTenantId in interface Execution

Specified by:

getTenantId in interface ProcessInstance

getName

public String getName()

Description copied from interface: ProcessInstance

Returns the name of this process instance.

Specified by:

getName in interface Execution

Specified by:

getName in interface ProcessInstance

getDescription

public String getDescription()

Description copied from interface: ProcessInstance

Returns the description of this process instance.

Specified by:

getDescription in interface Execution

Specified by:

getDescription in interface ProcessInstance

getLocalizedName

public String getLocalizedName()

Description copied from interface: ProcessInstance

Returns the localized name of this process instance.

Specified by:

getLocalizedName in interface ProcessInstance

getLocalizedDescription

public String getLocalizedDescription()

Description copied from interface: ProcessInstance

Returns the localized description of this process instance.

Specified by:

getLocalizedDescription in interface ProcessInstance

getRawObject

public ProcessInstance getRawObject()

getStartTime

public Date getStartTime()

Description copied from interface: ProcessInstance

Returns the start time of this process instance.

Specified by:

getStartTime in interface ProcessInstance

getStartUserId

public String getStartUserId()

Description copied from interface: ProcessInstance

Returns the user id of this process instance.

Specified by:

getStartUserId in interface ProcessInstance

getCallbackId

public String getCallbackId()

Description copied from interface: ProcessInstance

Returns the callback id of this process instance.

Specified by:

getCallbackId in interface ProcessInstance

getCallbackType

public String getCallbackType()

Description copied from interface: ProcessInstance

Returns the callback type of this process instance.

Specified by:

getCallbackType in interface ProcessInstance

getReferenceId

public String getReferenceId()

Description copied from interface: Execution

If this execution has created a case (through a case task), this will return the referenced case instance id.

Specified by:

getReferenceId in interface Execution

Returns:

the id of the optionally referenced case instance, if this execution created a case

getReferenceType

public String getReferenceType()

Description copied from interface: Execution

If this execution has created a case (through a case task), this will return the referenced case type (e.g. bpmn-x-to-cmmn-y type).

Specified by:

getReferenceType in interface Execution

Returns:

the type of the optionally referenced case instance, if this execution created a case

getPropagatedStageInstanceId

public String getPropagatedStageInstanceId()

Description copied from interface: Execution

If this execution 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 Execution

Returns:

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