Uses of Interface
org.camunda.bpm.engine.runtime.ProcessInstance

Packages that use ProcessInstance

Package	Description
org.camunda.bpm.engine	Public API of the Camunda Platform engine. Typical usage of the API starts by the creation of a ProcessEngineConfiguration (typically based on a configuration file), from which a ProcessEngine can be obtained. Through the services obtained from such a ProcessEngine, BPM and workflow operation can be executed: RepositoryService: Manages Deployments RuntimeService: For starting and searching ProcessInstances TaskService: Exposes operations to manage human (standalone) Tasks, such as claiming, completing and assigning tasks IdentityService: Used for managing Users, Groups and the relations between them ManagementService: Exposes engine admin and maintenance operations, which have no relation to the runtime execution of business processes HistoryService: Exposes information about ongoing and past process instances. FormService: Access to form data and rendered forms for starting new process instances and completing tasks.
org.camunda.bpm.engine.cdi
org.camunda.bpm.engine.cdi.impl.annotation
org.camunda.bpm.engine.impl	API implementation classes, which shouldn't directly be used by end-users.
org.camunda.bpm.engine.impl.cfg.auth
org.camunda.bpm.engine.impl.cmd
org.camunda.bpm.engine.impl.persistence.entity
org.camunda.bpm.engine.impl.runtime
org.camunda.bpm.engine.rest.dto.runtime
org.camunda.bpm.engine.runtime	Classes related to the RuntimeService.
org.camunda.bpm.engine.test.assertions.bpmn
org.camunda.bpm.qa.upgrade

Uses of ProcessInstance in org.camunda.bpm.engine

Methods in org.camunda.bpm.engine that return ProcessInstance

Modifier and Type	Method	Description
ProcessInstance	RuntimeService.startProcessInstanceById(String processDefinitionId)	Starts a new process instance in the exactly specified version of the process definition with the given id.
ProcessInstance	RuntimeService.startProcessInstanceById(String processDefinitionId, String businessKey)	Starts a new process instance in the exactly specified version of the process definition with the given id.
ProcessInstance	RuntimeService.startProcessInstanceById(String processDefinitionId, String businessKey, String caseInstanceId)	Starts a new process instance in the exactly specified version of the process definition with the given id.
ProcessInstance	RuntimeService.startProcessInstanceById(String processDefinitionId, String businessKey, String caseInstanceId, Map<String,Object> variables)	Starts a new process instance in the exactly specified version of the process definition with the given id.
ProcessInstance	RuntimeService.startProcessInstanceById(String processDefinitionId, String businessKey, Map<String,Object> variables)	Starts a new process instance in the exactly specified version of the process definition with the given id.
ProcessInstance	RuntimeService.startProcessInstanceById(String processDefinitionId, Map<String,Object> variables)	Starts a new process instance in the exactly specified version of the process definition with the given id.
ProcessInstance	RuntimeService.startProcessInstanceByKey(String processDefinitionKey)	Starts a new process instance in the latest version of the process definition with the given key.
ProcessInstance	RuntimeService.startProcessInstanceByKey(String processDefinitionKey, String businessKey)	Starts a new process instance in the latest version of the process definition with the given key.
ProcessInstance	RuntimeService.startProcessInstanceByKey(String processDefinitionKey, String businessKey, String caseInstanceId)	Starts a new process instance in the latest version of the process definition with the given key.
ProcessInstance	RuntimeService.startProcessInstanceByKey(String processDefinitionKey, String businessKey, String caseInstanceId, Map<String,Object> variables)	Starts a new process instance in the latest version of the process definition with the given key.
ProcessInstance	RuntimeService.startProcessInstanceByKey(String processDefinitionKey, String businessKey, Map<String,Object> variables)	Starts a new process instance in the latest version of the process definition with the given key.
ProcessInstance	RuntimeService.startProcessInstanceByKey(String processDefinitionKey, Map<String,Object> variables)	Starts a new process instance in the latest version of the process definition with the given key
ProcessInstance	RuntimeService.startProcessInstanceByMessage(String messageName)	Signals the process engine that a message is received and starts a new ProcessInstance.
ProcessInstance	RuntimeService.startProcessInstanceByMessage(String messageName, String businessKey)	Signals the process engine that a message is received and starts a new ProcessInstance.
ProcessInstance	RuntimeService.startProcessInstanceByMessage(String messageName, String businessKey, Map<String,Object> processVariables)	Signals the process engine that a message is received and starts a new ProcessInstance.
ProcessInstance	RuntimeService.startProcessInstanceByMessage(String messageName, Map<String,Object> processVariables)	Signals the process engine that a message is received and starts a new ProcessInstance.
ProcessInstance	RuntimeService.startProcessInstanceByMessageAndProcessDefinitionId(String messageName, String processDefinitionId)	Signals the process engine that a message is received and starts a new ProcessInstance.
ProcessInstance	RuntimeService.startProcessInstanceByMessageAndProcessDefinitionId(String messageName, String processDefinitionId, String businessKey)	Signals the process engine that a message is received and starts a new ProcessInstance.
ProcessInstance	RuntimeService.startProcessInstanceByMessageAndProcessDefinitionId(String messageName, String processDefinitionId, String businessKey, Map<String,Object> processVariables)	Signals the process engine that a message is received and starts a new ProcessInstance.
ProcessInstance	RuntimeService.startProcessInstanceByMessageAndProcessDefinitionId(String messageName, String processDefinitionId, Map<String,Object> processVariables)	Signals the process engine that a message is received and starts a new ProcessInstance.
ProcessInstance	FormService.submitStartForm(String processDefinitionId, String businessKey, Map<String,Object> properties)	Start a new process instance with the user data that was entered as properties in a start form.
ProcessInstance	FormService.submitStartForm(String processDefinitionId, Map<String,Object> properties)	Start a new process instance with the user data that was entered as properties in a start form.
ProcessInstance	FormService.submitStartFormData(String processDefinitionId, String businessKey, Map<String,String> properties)	Deprecated. use FormService.submitStartForm(String, String, Map)
ProcessInstance	FormService.submitStartFormData(String processDefinitionId, Map<String,String> properties)	Deprecated. use FormService.submitStartForm(String, Map)

Uses of ProcessInstance in org.camunda.bpm.engine.cdi

Methods in org.camunda.bpm.engine.cdi that return ProcessInstance

Modifier and Type	Method	Description
ProcessInstance	BusinessProcess.getProcessInstance()	Returns the ProcessInstance currently associated or 'null'
ProcessInstance	CurrentProcessInstance.getProcessInstance()	Returns the ProcessInstance currently associated or 'null'
ProcessInstance	BusinessProcess.startProcessById(String processDefinitionId)
ProcessInstance	BusinessProcess.startProcessById(String processDefinitionId, String businessKey)
ProcessInstance	BusinessProcess.startProcessById(String processDefinitionId, String businessKey, Map<String,Object> variables)
ProcessInstance	BusinessProcess.startProcessById(String processDefinitionId, Map<String,Object> variables)
ProcessInstance	BusinessProcess.startProcessByKey(String key)
ProcessInstance	BusinessProcess.startProcessByKey(String key, String businessKey)
ProcessInstance	BusinessProcess.startProcessByKey(String key, String businessKey, Map<String,Object> variables)
ProcessInstance	BusinessProcess.startProcessByKey(String key, Map<String,Object> variables)
ProcessInstance	BusinessProcess.startProcessByMessage(String messageName)
ProcessInstance	BusinessProcess.startProcessByMessage(String messageName, String businessKey, Map<String,Object> processVariables)
ProcessInstance	BusinessProcess.startProcessByMessage(String messageName, Map<String,Object> processVariables)

Uses of ProcessInstance in org.camunda.bpm.engine.cdi.impl.annotation

Methods in org.camunda.bpm.engine.cdi.impl.annotation with parameters of type ProcessInstance

Modifier and Type	Method	Description
String	BusinessKeyProducer.businessKey(ProcessInstance processInstance)

Uses of ProcessInstance in org.camunda.bpm.engine.impl

Methods in org.camunda.bpm.engine.impl that return ProcessInstance

Modifier and Type	Method	Description
ProcessInstance	MessageCorrelationBuilderImpl.correlateStartMessage()
ProcessInstance	ProcessInstantiationBuilderImpl.execute()
ProcessInstance	ProcessInstantiationBuilderImpl.execute(boolean skipCustomListeners, boolean skipIoMappings)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId, String businessKey)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId, String businessKey, String caseInstanceId)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId, String businessKey, String caseInstanceId, Map<String,Object> variables)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId, String businessKey, Map<String,Object> variables)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId, Map<String,Object> variables)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByKey(String processDefinitionKey)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByKey(String processDefinitionKey, String businessKey)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByKey(String processDefinitionKey, String businessKey, String caseInstanceId)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByKey(String processDefinitionKey, String businessKey, String caseInstanceId, Map<String,Object> variables)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByKey(String processDefinitionKey, String businessKey, Map<String,Object> variables)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByKey(String processDefinitionKey, Map<String,Object> variables)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByMessage(String messageName)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByMessage(String messageName, String businessKey)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByMessage(String messageName, String businessKey, Map<String,Object> processVariables)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByMessage(String messageName, Map<String,Object> processVariables)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByMessageAndProcessDefinitionId(String messageName, String processDefinitionId)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByMessageAndProcessDefinitionId(String messageName, String processDefinitionId, String businessKey)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByMessageAndProcessDefinitionId(String messageName, String processDefinitionId, String businessKey, Map<String,Object> processVariables)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByMessageAndProcessDefinitionId(String messageName, String processDefinitionId, Map<String,Object> processVariables)
ProcessInstance	FormServiceImpl.submitStartForm(String processDefinitionId, String businessKey, Map<String,Object> properties)
ProcessInstance	FormServiceImpl.submitStartForm(String processDefinitionId, Map<String,Object> properties)
ProcessInstance	FormServiceImpl.submitStartFormData(String processDefinitionId, String businessKey, Map<String,String> properties)
ProcessInstance	FormServiceImpl.submitStartFormData(String processDefinitionId, Map<String,String> properties)

Methods in org.camunda.bpm.engine.impl that return types with arguments of type ProcessInstance

Modifier and Type	Method	Description
List<ProcessInstance>	ConditionEvaluationBuilderImpl.evaluateStartConditions()
List<ProcessInstance>	NativeProcessInstanceQueryImpl.executeList(CommandContext commandContext, Map<String,Object> parameterMap, int firstResult, int maxResults)
List<ProcessInstance>	ProcessInstanceQueryImpl.executeList(CommandContext commandContext, Page page)

Uses of ProcessInstance in org.camunda.bpm.engine.impl.cfg.auth

Methods in org.camunda.bpm.engine.impl.cfg.auth with parameters of type ProcessInstance

Modifier and Type	Method	Description
AuthorizationEntity[]	DefaultAuthorizationProvider.newProcessInstance(ProcessInstance processInstance)
AuthorizationEntity[]	ResourceAuthorizationProvider.newProcessInstance(ProcessInstance processInstance)	Invoked whenever a new process instance is started

Uses of ProcessInstance in org.camunda.bpm.engine.impl.cmd

Methods in org.camunda.bpm.engine.impl.cmd that return ProcessInstance

Modifier and Type	Method	Description
ProcessInstance	SubmitStartFormCmd.execute(CommandContext commandContext)
protected ProcessInstance	AbstractCorrelateMessageCmd.instantiateProcess(CommandContext commandContext, CorrelationHandlerResult correlationResult)
protected ProcessInstance	EvaluateStartConditionCmd.instantiateProcess(CommandContext commandContext, ConditionHandlerResult result)

Methods in org.camunda.bpm.engine.impl.cmd that return types with arguments of type ProcessInstance

Modifier and Type	Method	Description
List<ProcessInstance>	EvaluateStartConditionCmd.execute(CommandContext commandContext)
protected List<ProcessInstance>	AbstractSetProcessInstanceStateCmd.obtainProcessInstances(CommandContext commandContext)

Method parameters in org.camunda.bpm.engine.impl.cmd with type arguments of type ProcessInstance

Modifier and Type	Method	Description
void	AbstractDeleteProcessInstanceCmd.triggerHistoryEvent(List<ProcessInstance> subProcesslist)

Uses of ProcessInstance in org.camunda.bpm.engine.impl.persistence.entity

Classes in org.camunda.bpm.engine.impl.persistence.entity that implement ProcessInstance

Modifier and Type	Class	Description
class	ExecutionEntity
class	ProcessInstanceWithVariablesImpl

Methods in org.camunda.bpm.engine.impl.persistence.entity that return types with arguments of type ProcessInstance

Modifier and Type	Method	Description
List<ProcessInstance>	ExecutionManager.findProcessInstanceByNativeQuery(Map<String,Object> parameterMap, int firstResult, int maxResults)
List<ProcessInstance>	ExecutionManager.findProcessInstancesByQueryCriteria(ProcessInstanceQueryImpl processInstanceQuery, Page page)

Uses of ProcessInstance in org.camunda.bpm.engine.impl.runtime

Fields in org.camunda.bpm.engine.impl.runtime declared as ProcessInstance

Modifier and Type	Field	Description
protected ProcessInstance	MessageCorrelationResultImpl.processInstance

Methods in org.camunda.bpm.engine.impl.runtime that return ProcessInstance

Modifier and Type	Method	Description
ProcessInstance	MessageCorrelationResultImpl.getProcessInstance()

Methods in org.camunda.bpm.engine.impl.runtime with parameters of type ProcessInstance

Modifier and Type	Method	Description
void	MessageCorrelationResultImpl.setProcessInstance(ProcessInstance processInstance)

Uses of ProcessInstance in org.camunda.bpm.engine.rest.dto.runtime

Methods in org.camunda.bpm.engine.rest.dto.runtime with parameters of type ProcessInstance

Modifier and Type	Method	Description
static ProcessInstanceDto	ProcessInstanceDto.fromProcessInstance(ProcessInstance instance)

Constructors in org.camunda.bpm.engine.rest.dto.runtime with parameters of type ProcessInstance

Modifier	Constructor	Description
	ProcessInstanceDto(ProcessInstance instance)
	ProcessInstanceWithVariablesDto(ProcessInstance instance)

Uses of ProcessInstance in org.camunda.bpm.engine.runtime

Subinterfaces of ProcessInstance in org.camunda.bpm.engine.runtime

Modifier and Type	Interface	Description
interface	ProcessInstanceWithVariables	Represents a process instance with the corresponding latest variables.

Methods in org.camunda.bpm.engine.runtime that return ProcessInstance

Modifier and Type	Method	Description
ProcessInstance	MessageCorrelationBuilder.correlateStartMessage()	Executes the message correlation.
ProcessInstance	ProcessInstantiationBuilder.execute()	Start the process instance.
ProcessInstance	ProcessInstantiationBuilder.execute(boolean skipCustomListeners, boolean skipIoMappings)	Start the process instance.
ProcessInstance	MessageCorrelationResult.getProcessInstance()	Returns the process instance id on which the message was correlated to.

Methods in org.camunda.bpm.engine.runtime that return types with arguments of type ProcessInstance

Modifier and Type	Method	Description
List<ProcessInstance>	ConditionEvaluationBuilder.evaluateStartConditions()

Uses of ProcessInstance in org.camunda.bpm.engine.test.assertions.bpmn

Methods in org.camunda.bpm.engine.test.assertions.bpmn that return ProcessInstance

Modifier and Type	Method	Description
static ProcessInstance	BpmnAwareTests.calledProcessInstance()	Helper method to easily access the only called process instance currently available in the context of the last asserted process instance.
static ProcessInstance	BpmnAwareTests.calledProcessInstance(String processDefinitionKey)	Helper method to easily access the only called process instance with the given processDefinitionKey currently available in the context of the last asserted process instance.
static ProcessInstance	BpmnAwareTests.calledProcessInstance(String processDefinitionKey, ProcessInstance processInstance)	Helper method to easily access the only called process instance with the given processDefinitionKey currently available in the context of the given process instance.
static ProcessInstance	BpmnAwareTests.calledProcessInstance(ProcessInstance processInstance)	Helper method to easily access the only called process instance currently available in the context of the given process instance.
static ProcessInstance	BpmnAwareTests.calledProcessInstance(ProcessInstanceQuery processInstanceQuery)	Helper method to easily access the only called process instance compliant to a given processInstanceQuery and currently available in the context of the last asserted process instance.
static ProcessInstance	BpmnAwareTests.calledProcessInstance(ProcessInstanceQuery processInstanceQuery, ProcessInstance processInstance)	Helper method to easily access the only called process instance compliant to a given processInstanceQuery and currently available in the context of the given process instance.
protected ProcessInstance	ProcessInstanceAssert.getCurrent()

Methods in org.camunda.bpm.engine.test.assertions.bpmn with parameters of type ProcessInstance

Modifier and Type	Method	Description
static ProcessInstanceAssert	BpmnAwareTests.assertThat(ProcessInstance actual)	Assert that...
protected static CalledProcessInstanceAssert	CalledProcessInstanceAssert.assertThat(ProcessEngine engine, ProcessInstance actual)
protected static ProcessInstanceAssert	ProcessInstanceAssert.assertThat(ProcessEngine engine, ProcessInstance actual)
static ProcessInstance	BpmnAwareTests.calledProcessInstance(String processDefinitionKey, ProcessInstance processInstance)	Helper method to easily access the only called process instance with the given processDefinitionKey currently available in the context of the given process instance.
static ProcessInstance	BpmnAwareTests.calledProcessInstance(ProcessInstance processInstance)	Helper method to easily access the only called process instance currently available in the context of the given process instance.
static ProcessInstance	BpmnAwareTests.calledProcessInstance(ProcessInstanceQuery processInstanceQuery, ProcessInstance processInstance)	Helper method to easily access the only called process instance compliant to a given processInstanceQuery and currently available in the context of the given process instance.
static ExternalTask	BpmnAwareTests.externalTask(String activityId, ProcessInstance processInstance)	Helper method to easily access the only external task with the given activityId currently available in the context of the given process instance.
static ExternalTask	BpmnAwareTests.externalTask(ExternalTaskQuery externalTaskQuery, ProcessInstance processInstance)	Helper method to easily access the only external task compliant to a given externalTaskQuery and currently available in the context of the given process instance.
static ExternalTask	BpmnAwareTests.externalTask(ProcessInstance processInstance)	Helper method to easily access the only external task currently available in the context of the given process instance.
static Job	BpmnAwareTests.job(String activityId, ProcessInstance processInstance)	Helper method to easily access the only job with the given activityId currently available in the context of the given process instance.
static Job	BpmnAwareTests.job(JobQuery jobQuery, ProcessInstance processInstance)	Helper method to easily access the only job compliant to a given jobQuery and currently available in the context of the given process instance.
static Job	BpmnAwareTests.job(ProcessInstance processInstance)	Helper method to easily access the only job currently available in the context of the given process instance.
static ProcessDefinition	BpmnAwareTests.processDefinition(ProcessInstance processInstance)	Helper method to easily access the process definition on which the given process instance is based.
static Task	BpmnAwareTests.task(String taskDefinitionKey, ProcessInstance processInstance)	Helper method to easily access the only task with the given taskDefinitionKey currently available in the context of the given process instance.
static Task	BpmnAwareTests.task(ProcessInstance processInstance)	Helper method to easily access the only task currently available in the context of the given process instance.
static Task	BpmnAwareTests.task(TaskQuery taskQuery, ProcessInstance processInstance)	Helper method to easily access the only task compliant to a given taskQuery and currently available in the context of the given process instance.
protected String	ProcessInstanceAssert.toString(ProcessInstance processInstance)

Constructors in org.camunda.bpm.engine.test.assertions.bpmn with parameters of type ProcessInstance

Modifier	Constructor	Description
protected	CalledProcessInstanceAssert(ProcessEngine engine, ProcessInstance actual)
protected	ProcessInstanceAssert(ProcessEngine engine, ProcessInstance actual)
protected	ProcessInstanceAssert(ProcessEngine engine, ProcessInstance actual, Class<?> selfType)

Uses of ProcessInstance in org.camunda.bpm.qa.upgrade

Methods in org.camunda.bpm.qa.upgrade that return ProcessInstance

Modifier and Type	Method	Description
ProcessInstance	UpgradeTestRule.processInstance()