Uses of Interface
org.flowable.engine.runtime.ProcessInstance

Packages that use ProcessInstance

Package	Description
org.flowable.engine	Public API of the Flowable 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 administration and maintenance operations, which have no relation to the runtime exection 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.flowable.engine.compatibility
org.flowable.engine.impl	API implementation classes, which shouldn't directly be used by end-users.
org.flowable.engine.impl.cmd
org.flowable.engine.impl.migration
org.flowable.engine.impl.persistence.entity
org.flowable.engine.impl.persistence.entity.data
org.flowable.engine.impl.persistence.entity.data.impl
org.flowable.engine.impl.runtime
org.flowable.engine.impl.test
org.flowable.engine.impl.util
org.flowable.engine.interceptor
org.flowable.engine.migration
org.flowable.engine.runtime	Classes related to the RuntimeService.
org.flowable.rest.service.api
org.flowable.rest.service.api.runtime.process

Uses of ProcessInstance in org.flowable.engine

Methods in org.flowable.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, 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, 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.startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String tenantId)	Similar to RuntimeService.startProcessInstanceByKey(String), but using a specific tenant identifier.
ProcessInstance	RuntimeService.startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String businessKey, String tenantId)	Similar to RuntimeService.startProcessInstanceByKey(String, String), but using a specific tenant identifier.
ProcessInstance	RuntimeService.startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String businessKey, Map<String,Object> variables, String tenantId)	Similar to RuntimeService.startProcessInstanceByKey(String, String, Map), but using a specific tenant identifier.
ProcessInstance	RuntimeService.startProcessInstanceByKeyAndTenantId(String processDefinitionKey, Map<String,Object> variables, String tenantId)	Similar to RuntimeService.startProcessInstanceByKey(String, Map), but using a specific tenant identifier.
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.startProcessInstanceByMessageAndTenantId(String messageName, String tenantId)	Similar to RuntimeService.startProcessInstanceByMessage(String), but with tenant context.
ProcessInstance	RuntimeService.startProcessInstanceByMessageAndTenantId(String messageName, String businessKey, String tenantId)	Similar to RuntimeService.startProcessInstanceByMessage(String, String), but with tenant context.
ProcessInstance	RuntimeService.startProcessInstanceByMessageAndTenantId(String messageName, String businessKey, Map<String,Object> processVariables, String tenantId)	Similar to RuntimeService.startProcessInstanceByMessage(String, String, Map), but with tenant context.
ProcessInstance	RuntimeService.startProcessInstanceByMessageAndTenantId(String messageName, Map<String,Object> processVariables, String tenantId)	Similar to RuntimeService.startProcessInstanceByMessage(String, Map), but with tenant context.
ProcessInstance	RuntimeService.startProcessInstanceWithForm(String processDefinitionId, String outcome, Map<String,Object> variables, String processInstanceName)	Starts a new process instance in the exactly specified version of the process definition with the given id.
ProcessInstance	FormService.submitStartFormData(String processDefinitionId, String businessKey, Map<String,String> properties)	Start a new process instance with the user data that was entered as properties in a start form.
ProcessInstance	FormService.submitStartFormData(String processDefinitionId, Map<String,String> properties)	Start a new process instance with the user data that was entered as properties in a start form.

Methods in org.flowable.engine with parameters of type ProcessInstance

Modifier and Type	Method	Description
void	InternalProcessLocalizationManager.localize(ProcessInstance processInstance, String locale, boolean withLocalizationFallback)

Uses of ProcessInstance in org.flowable.engine.compatibility

Methods in org.flowable.engine.compatibility that return ProcessInstance

Modifier and Type	Method	Description
ProcessInstance	Flowable5CompatibilityHandler.getProcessInstance(String processInstanceId)
ProcessInstance	Flowable5CompatibilityHandler.startProcessInstance(String processDefinitionKey, String processDefinitionId, Map<String,Object> variables, Map<String,Object> transientVariables, String businessKey, String tenantId, String processInstanceName)
ProcessInstance	Flowable5CompatibilityHandler.startProcessInstanceByMessage(String messageName, Map<String,Object> variables, Map<String,Object> transientVariables, String businessKey, String tenantId)
ProcessInstance	Flowable5CompatibilityHandler.submitStartFormData(String processDefinitionId, String businessKey, Map<String,String> properties)

Methods in org.flowable.engine.compatibility with parameters of type ProcessInstance

Modifier and Type	Method	Description
Map<String,Object>	Flowable5CompatibilityHandler.getVariables(ProcessInstance processInstance)

Uses of ProcessInstance in org.flowable.engine.impl

Methods in org.flowable.engine.impl that return ProcessInstance

Modifier and Type	Method	Description
ProcessInstance	RuntimeServiceImpl.startProcessInstance(ProcessInstanceBuilderImpl processInstanceBuilder)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceAsync(ProcessInstanceBuilderImpl processInstanceBuilder)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId, String businessKey)
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, Map<String,Object> variables)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByKey(String processDefinitionKey, Map<String,Object> variables)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String tenantId)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String businessKey, String tenantId)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String businessKey, Map<String,Object> variables, String tenantId)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByKeyAndTenantId(String processDefinitionKey, Map<String,Object> variables, String tenantId)
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.startProcessInstanceByMessageAndTenantId(String messageName, String tenantId)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByMessageAndTenantId(String messageName, String businessKey, String tenantId)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByMessageAndTenantId(String messageName, String businessKey, Map<String,Object> processVariables, String tenantId)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceByMessageAndTenantId(String messageName, Map<String,Object> processVariables, String tenantId)
ProcessInstance	RuntimeServiceImpl.startProcessInstanceWithForm(String processDefinitionId, String outcome, Map<String,Object> variables, String processInstanceName)
ProcessInstance	FormServiceImpl.submitStartFormData(String processDefinitionId, String businessKey, Map<String,String> properties)
ProcessInstance	FormServiceImpl.submitStartFormData(String processDefinitionId, Map<String,String> properties)

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

Modifier and Type	Method	Description
List<ProcessInstance>	NativeProcessInstanceQueryImpl.executeList(CommandContext commandContext, Map<String,Object> parameterMap)
List<ProcessInstance>	ProcessInstanceQueryImpl.executeList(CommandContext commandContext)

Methods in org.flowable.engine.impl with parameters of type ProcessInstance

Modifier and Type	Method	Description
void	DefaultProcessLocalizationManager.localize(ProcessInstance processInstance, String locale, boolean withLocalizationFallback)

Uses of ProcessInstance in org.flowable.engine.impl.cmd

Methods in org.flowable.engine.impl.cmd that return ProcessInstance

Modifier and Type	Method	Description
ProcessInstance	StartProcessInstanceAsyncCmd.execute(CommandContext commandContext)
ProcessInstance	StartProcessInstanceByMessageCmd.execute(CommandContext commandContext)
ProcessInstance	StartProcessInstanceCmd.execute(CommandContext commandContext)
protected ProcessInstance	SubmitStartFormCmd.execute(CommandContext commandContext, ProcessDefinitionEntity processDefinition)
protected ProcessInstance	StartProcessInstanceCmd.handleProcessInstanceWithForm(CommandContext commandContext, ProcessDefinition processDefinition, ProcessEngineConfigurationImpl processEngineConfiguration)
protected ProcessInstance	StartProcessInstanceCmd.startProcessInstance(ProcessDefinition processDefinition)

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

Modifier and Type	Method	Description
protected List<ProcessInstance>	AbstractSetProcessDefinitionStateCmd.fetchProcessInstancesPage(CommandContext commandContext, ProcessDefinition processDefinition, int currentPageStartIndex)

Methods in org.flowable.engine.impl.cmd with parameters of type ProcessInstance

Modifier and Type	Method	Description
protected void	AbstractDynamicInjectionCmd.createDerivedProcessDefinition(CommandContext commandContext, ProcessInstance processInstance)
protected abstract AbstractSetProcessInstanceStateCmd	AbstractSetProcessDefinitionStateCmd.getProcessInstanceChangeStateCmd(ProcessInstance processInstance)	Subclasses should return a Command implementation that matches the process definition state change.
protected AbstractSetProcessInstanceStateCmd	ActivateProcessDefinitionCmd.getProcessInstanceChangeStateCmd(ProcessInstance processInstance)
protected AbstractSetProcessInstanceStateCmd	SuspendProcessDefinitionCmd.getProcessInstanceChangeStateCmd(ProcessInstance processInstance)

Uses of ProcessInstance in org.flowable.engine.impl.migration

Methods in org.flowable.engine.impl.migration with parameters of type ProcessInstance

Modifier and Type	Method	Description
protected void	ProcessInstanceMigrationManagerImpl.changeProcessDefinitionReferenceOfHistory(ProcessInstance processInstance, ProcessDefinition processDefinition, CommandContext commandContext)
protected void	ProcessInstanceMigrationManagerImpl.doMigrateProcessInstance(ProcessInstance processInstance, ProcessDefinition procDefToMigrateTo, ProcessInstanceMigrationDocument document, CommandContext commandContext)
protected void	ProcessInstanceMigrationManagerImpl.executeExpression(ProcessInstance processInstance, ProcessDefinition procDefToMigrateTo, String preUpgradeJavaDelegateExpression, CommandContext commandContext)
protected void	ProcessInstanceMigrationManagerImpl.executeJavaDelegate(ProcessInstance processInstance, ProcessDefinition procDefToMigrateTo, String preUpgradeJavaDelegate, CommandContext commandContext)
protected void	ProcessInstanceMigrationManagerImpl.executeScript(ProcessInstance processInstance, ProcessDefinition procDefToMigrateTo, Script script, CommandContext commandContext)

Uses of ProcessInstance in org.flowable.engine.impl.persistence.entity

Subinterfaces of ProcessInstance in org.flowable.engine.impl.persistence.entity

Modifier and Type	Interface	Description
interface	ExecutionEntity

Classes in org.flowable.engine.impl.persistence.entity that implement ProcessInstance

Modifier and Type	Class	Description
class	ExecutionEntityImpl

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

Modifier and Type	Method	Description
List<ProcessInstance>	ExecutionEntityManager.findProcessInstanceAndVariablesByQueryCriteria(ProcessInstanceQueryImpl executionQuery)
List<ProcessInstance>	ExecutionEntityManagerImpl.findProcessInstanceAndVariablesByQueryCriteria(ProcessInstanceQueryImpl executionQuery)
List<ProcessInstance>	ExecutionEntityManager.findProcessInstanceByNativeQuery(Map<String,Object> parameterMap)
List<ProcessInstance>	ExecutionEntityManagerImpl.findProcessInstanceByNativeQuery(Map<String,Object> parameterMap)
List<ProcessInstance>	ExecutionEntityManager.findProcessInstanceByQueryCriteria(ProcessInstanceQueryImpl executionQuery)
List<ProcessInstance>	ExecutionEntityManagerImpl.findProcessInstanceByQueryCriteria(ProcessInstanceQueryImpl executionQuery)

Uses of ProcessInstance in org.flowable.engine.impl.persistence.entity.data

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

Modifier and Type	Method	Description
List<ProcessInstance>	ExecutionDataManager.findProcessInstanceAndVariablesByQueryCriteria(ProcessInstanceQueryImpl executionQuery)
List<ProcessInstance>	ExecutionDataManager.findProcessInstanceByNativeQuery(Map<String,Object> parameterMap)
List<ProcessInstance>	ExecutionDataManager.findProcessInstanceByQueryCriteria(ProcessInstanceQueryImpl executionQuery)

Uses of ProcessInstance in org.flowable.engine.impl.persistence.entity.data.impl

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

Modifier and Type	Method	Description
List<ProcessInstance>	MybatisExecutionDataManager.findProcessInstanceAndVariablesByQueryCriteria(ProcessInstanceQueryImpl processInstanceQuery)
List<ProcessInstance>	MybatisExecutionDataManager.findProcessInstanceByNativeQuery(Map<String,Object> parameterMap)
List<ProcessInstance>	MybatisExecutionDataManager.findProcessInstanceByQueryCriteria(ProcessInstanceQueryImpl processInstanceQuery)

Uses of ProcessInstance in org.flowable.engine.impl.runtime

Methods in org.flowable.engine.impl.runtime that return ProcessInstance

Modifier and Type	Method	Description
ProcessInstance	ProcessInstanceBuilderImpl.start()
ProcessInstance	ProcessInstanceBuilderImpl.startAsync()

Uses of ProcessInstance in org.flowable.engine.impl.test

Methods in org.flowable.engine.impl.test with parameters of type ProcessInstance

Modifier and Type	Method	Description
protected void	AbstractFlowableTestCase.assertHistoricActivitiesDeleteReason(ProcessInstance processInstance, String expectedDeleteReason, String... activityIds)
protected void	AbstractFlowableTestCase.assertHistoricTasksDeleteReason(ProcessInstance processInstance, String expectedDeleteReason, String... taskNames)

Uses of ProcessInstance in org.flowable.engine.impl.util

Methods in org.flowable.engine.impl.util that return ProcessInstance

Modifier and Type	Method	Description
ProcessInstance	ProcessInstanceHelper.createAndStartProcessInstanceByMessage(ProcessDefinition processDefinition, String messageName, String businessKey, String businessStatus, Map<String,Object> variables, Map<String,Object> transientVariables, String callbackId, String callbackType, String referenceId, String referenceType, String ownerId, String assigneeId)
ProcessInstance	ProcessInstanceHelper.createAndStartProcessInstanceWithInitialFlowElement(ProcessDefinition processDefinition, String businessKey, String businessStatus, String processInstanceName, String overrideDefinitionTenantId, String predefinedProcessInstanceId, FlowElement initialFlowElement, Process process, Map<String,Object> variables, Map<String,Object> transientVariables, String callbackId, String callbackType, String referenceId, String referenceType, String ownerId, String assigneeId, String stageInstanceId, boolean startProcessInstance)
ProcessInstance	ProcessInstanceHelper.createAndStartProcessInstanceWithInitialFlowElement(ProcessDefinition processDefinition, String businessKey, String businessStatus, String processInstanceName, FlowElement initialFlowElement, Process process, Map<String,Object> variables, Map<String,Object> transientVariables, String ownerId, String assigneeId, boolean startProcessInstance)
ProcessInstance	ProcessInstanceHelper.createProcessInstance(ProcessDefinition processDefinition, String businessKey, String businessStatus, String processInstanceName, String startEventId, String overrideDefinitionTenantId, String predefinedProcessInstanceId, Map<String,Object> variables, Map<String,Object> transientVariables, String callbackId, String callbackType, String referenceId, String referenceType, String ownerId, String assigneeId, String stageInstanceId, boolean startProcessInstance)
ProcessInstance	ProcessInstanceHelper.createProcessInstance(ProcessDefinition processDefinition, String businessKey, String businessStatus, String processInstanceName, Map<String,Object> variables, Map<String,Object> transientVariables, String ownerId, String assigneeId)

Methods in org.flowable.engine.impl.util with parameters of type ProcessInstance

Modifier and Type	Method	Description
void	ProcessInstanceHelper.callCaseInstanceStateChangeCallbacks(CommandContext commandContext, ProcessInstance processInstance, String oldState, String newState)

Uses of ProcessInstance in org.flowable.engine.interceptor

Method parameters in org.flowable.engine.interceptor with type arguments of type ProcessInstance

Modifier and Type	Method	Description
void	ProcessInstanceQueryInterceptor.afterProcessInstanceQueryExecute(ProcessInstanceQuery processInstanceQuery, List<ProcessInstance> processInstances)

Uses of ProcessInstance in org.flowable.engine.migration

Methods in org.flowable.engine.migration with parameters of type ProcessInstance

Modifier and Type	Method	Description
void	ProcessInstanceMigrationCallback.processInstanceMigrated(ProcessInstance processInstance, ProcessDefinition procDefToMigrateTo, ProcessInstanceMigrationDocument document, CommandContext commandContext)

Uses of ProcessInstance in org.flowable.engine.runtime

Methods in org.flowable.engine.runtime that return ProcessInstance

Modifier and Type	Method	Description
ProcessInstance	ProcessInstanceBuilder.start()	Start the process instance
ProcessInstance	ProcessInstanceBuilder.startAsync()	Start the process instance asynchronously

Uses of ProcessInstance in org.flowable.rest.service.api

Methods in org.flowable.rest.service.api with parameters of type ProcessInstance

Modifier and Type	Method	Description
void	BpmnRestApiInterceptor.accessProcessInstanceIdentityLink(ProcessInstance processInstance, IdentityLink identityLink)
void	BpmnRestApiInterceptor.accessProcessInstanceIdentityLinks(ProcessInstance processInstance)
void	BpmnRestApiInterceptor.accessProcessInstanceInfoById(ProcessInstance processInstance)
void	BpmnRestApiInterceptor.createProcessInstanceIdentityLink(ProcessInstance processInstance, RestIdentityLink identityLink)
ProcessInstanceResponse	RestResponseFactory.createProcessInstanceResponse(ProcessInstance processInstance)
ProcessInstanceResponse	RestResponseFactory.createProcessInstanceResponse(ProcessInstance processInstance, boolean returnVariables, Map<String,Object> runtimeVariableMap, List<HistoricVariableInstance> historicVariableList)
ProcessInstanceResponse	RestResponseFactory.createProcessInstanceResponse(ProcessInstance processInstance, RestUrlBuilder urlBuilder)
void	BpmnRestApiInterceptor.deleteProcessInstance(ProcessInstance processInstance)
void	BpmnRestApiInterceptor.deleteProcessInstanceIdentityLink(ProcessInstance processInstance, IdentityLink identityLink)
void	BpmnRestApiInterceptor.evaluateProcessInstanceConditionalEvents(ProcessInstance processInstance)
protected ProcessInstanceResponse	RestResponseFactory.internalCreateProcessInstanceResponse(ProcessInstance processInstance, RestUrlBuilder urlBuilder)
void	BpmnRestApiInterceptor.updateProcessInstance(ProcessInstance processInstance, ProcessInstanceUpdateRequest updateRequest)

Method parameters in org.flowable.rest.service.api with type arguments of type ProcessInstance

Modifier and Type	Method	Description
List<ProcessInstanceResponse>	RestResponseFactory.createProcessInstanceResponseList(List<ProcessInstance> processInstances)

Uses of ProcessInstance in org.flowable.rest.service.api.runtime.process

Methods in org.flowable.rest.service.api.runtime.process that return ProcessInstance

Modifier and Type	Method	Description
protected ProcessInstance	BaseProcessInstanceResource.getProcessInstanceFromRequest(String processInstanceId)	Returns the ProcessInstance that is requested and calls the access interceptor.
protected ProcessInstance	BaseProcessInstanceResource.getProcessInstanceFromRequestWithoutAccessCheck(String processInstanceId)	Returns the ProcessInstance that is requested without calling the access interceptor Throws the right exceptions when bad request was made or instance was not found.

Methods in org.flowable.rest.service.api.runtime.process with parameters of type ProcessInstance

Modifier and Type	Method	Description
protected ProcessInstanceResponse	ProcessInstanceResource.activateProcessInstance(ProcessInstance processInstance)
protected ProcessInstanceResponse	ProcessInstanceResource.suspendProcessInstance(ProcessInstance processInstance)