ProcessInstance (Camunda Platform Javadocs 7.20.4-ee)

All Superinterfaces:: Execution

All Known Subinterfaces:: ProcessInstanceWithVariables

All Known Implementing Classes:: ExecutionEntity, ProcessInstanceWithVariablesImpl

public interface ProcessInstance extends Execution

Represents one execution of a ProcessDefinition.

Author:: Tom Baeyens, Joram Barrez, Daniel Meyer

Method Summary

Modifier and Type

Method

Description

String

getBusinessKey()

The business key of this process instance.

String

getCaseInstanceId()

The id of the case instance associated with this process instance.

String

getProcessDefinitionId()

The id of the process definition of the process instance.

String

getRootProcessInstanceId()

The id of the root process instance associated with this process instance.

boolean

isSuspended()

returns true if the process instance is suspended

Methods inherited from interface org.camunda.bpm.engine.runtime.Execution
getId, getProcessInstanceId, getTenantId, isEnded

Method Details
- getProcessDefinitionId
  
  String getProcessDefinitionId()
  
  The id of the process definition of the process instance.
- getBusinessKey
  
  String getBusinessKey()
  
  The business key of this process instance.
- getRootProcessInstanceId
  
  String getRootProcessInstanceId()
  
  The id of the root process instance associated with this process instance.
- getCaseInstanceId
  
  String getCaseInstanceId()
  
  The id of the case instance associated with this process instance.
- isSuspended
  
  boolean isSuspended()
  
  returns true if the process instance is suspended
  
  Specified by:
  
  isSuspended in interface Execution