Uses of Interface
org.flowable.engine.runtime.ProcessInstance
Packages that use ProcessInstance
Package
Description
Public API of the Flowable engine.
Typical usage of the API starts by the creation of a
Through the services obtained from such a
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.API implementation classes, which shouldn't directly be used by end-users.
Classes related to the
RuntimeService.-
Uses of ProcessInstance in org.flowable.engine
Methods in org.flowable.engine that return ProcessInstanceModifier and TypeMethodDescriptionRuntimeService.startProcessInstanceById(String processDefinitionId) Starts a new process instance in the exactly specified version of the process definition with the given id.RuntimeService.startProcessInstanceById(String processDefinitionId, String businessKey) Starts a new process instance in the exactly specified version of the process definition with the given id.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.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.RuntimeService.startProcessInstanceByKey(String processDefinitionKey) Starts a new process instance in the latest version of the process definition with the given key.RuntimeService.startProcessInstanceByKey(String processDefinitionKey, String businessKey) Starts a new process instance in the latest version of the process definition with the given key.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.RuntimeService.startProcessInstanceByKey(String processDefinitionKey, Map<String, Object> variables) Starts a new process instance in the latest version of the process definition with the given keyRuntimeService.startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String tenantId) Similar toRuntimeService.startProcessInstanceByKey(String), but using a specific tenant identifier.RuntimeService.startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String businessKey, String tenantId) Similar toRuntimeService.startProcessInstanceByKey(String, String), but using a specific tenant identifier.RuntimeService.startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String businessKey, Map<String, Object> variables, String tenantId) Similar toRuntimeService.startProcessInstanceByKey(String, String, Map), but using a specific tenant identifier.RuntimeService.startProcessInstanceByKeyAndTenantId(String processDefinitionKey, Map<String, Object> variables, String tenantId) Similar toRuntimeService.startProcessInstanceByKey(String, Map), but using a specific tenant identifier.RuntimeService.startProcessInstanceByMessage(String messageName) Signals the process engine that a message is received and starts a newProcessInstance.RuntimeService.startProcessInstanceByMessage(String messageName, String businessKey) Signals the process engine that a message is received and starts a newProcessInstance.RuntimeService.startProcessInstanceByMessage(String messageName, String businessKey, Map<String, Object> processVariables) Signals the process engine that a message is received and starts a newProcessInstance.RuntimeService.startProcessInstanceByMessage(String messageName, Map<String, Object> processVariables) Signals the process engine that a message is received and starts a newProcessInstance.RuntimeService.startProcessInstanceByMessageAndTenantId(String messageName, String tenantId) Similar toRuntimeService.startProcessInstanceByMessage(String), but with tenant context.RuntimeService.startProcessInstanceByMessageAndTenantId(String messageName, String businessKey, String tenantId) Similar toRuntimeService.startProcessInstanceByMessage(String, String), but with tenant context.RuntimeService.startProcessInstanceByMessageAndTenantId(String messageName, String businessKey, Map<String, Object> processVariables, String tenantId) Similar toRuntimeService.startProcessInstanceByMessage(String, String, Map), but with tenant context.RuntimeService.startProcessInstanceByMessageAndTenantId(String messageName, Map<String, Object> processVariables, String tenantId) Similar toRuntimeService.startProcessInstanceByMessage(String, Map), but with tenant context.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.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.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 ProcessInstanceModifier and TypeMethodDescriptionvoidInternalProcessLocalizationManager.localize(ProcessInstance processInstance, String locale, boolean withLocalizationFallback) -
Uses of ProcessInstance in org.flowable.engine.compatibility
Methods in org.flowable.engine.compatibility that return ProcessInstanceModifier and TypeMethodDescriptionFlowable5CompatibilityHandler.getProcessInstance(String processInstanceId) Flowable5CompatibilityHandler.startProcessInstance(String processDefinitionKey, String processDefinitionId, Map<String, Object> variables, Map<String, Object> transientVariables, String businessKey, String tenantId, String processInstanceName) Flowable5CompatibilityHandler.startProcessInstanceByMessage(String messageName, Map<String, Object> variables, Map<String, Object> transientVariables, String businessKey, String tenantId) Flowable5CompatibilityHandler.submitStartFormData(String processDefinitionId, String businessKey, Map<String, String> properties) Methods in org.flowable.engine.compatibility with parameters of type ProcessInstanceModifier and TypeMethodDescriptionFlowable5CompatibilityHandler.getVariables(ProcessInstance processInstance) -
Uses of ProcessInstance in org.flowable.engine.impl
Methods in org.flowable.engine.impl that return ProcessInstanceModifier and TypeMethodDescriptionRuntimeServiceImpl.startProcessInstance(ProcessInstanceBuilderImpl processInstanceBuilder) RuntimeServiceImpl.startProcessInstanceAsync(ProcessInstanceBuilderImpl processInstanceBuilder) RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId) RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId, String businessKey) RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId, String businessKey, Map<String, Object> variables) RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId, Map<String, Object> variables) RuntimeServiceImpl.startProcessInstanceByKey(String processDefinitionKey) RuntimeServiceImpl.startProcessInstanceByKey(String processDefinitionKey, String businessKey) RuntimeServiceImpl.startProcessInstanceByKey(String processDefinitionKey, String businessKey, Map<String, Object> variables) RuntimeServiceImpl.startProcessInstanceByKey(String processDefinitionKey, Map<String, Object> variables) RuntimeServiceImpl.startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String tenantId) RuntimeServiceImpl.startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String businessKey, String tenantId) RuntimeServiceImpl.startProcessInstanceByKeyAndTenantId(String processDefinitionKey, String businessKey, Map<String, Object> variables, String tenantId) RuntimeServiceImpl.startProcessInstanceByKeyAndTenantId(String processDefinitionKey, Map<String, Object> variables, String tenantId) RuntimeServiceImpl.startProcessInstanceByMessage(String messageName) RuntimeServiceImpl.startProcessInstanceByMessage(String messageName, String businessKey) RuntimeServiceImpl.startProcessInstanceByMessage(String messageName, String businessKey, Map<String, Object> processVariables) RuntimeServiceImpl.startProcessInstanceByMessage(String messageName, Map<String, Object> processVariables) RuntimeServiceImpl.startProcessInstanceByMessageAndTenantId(String messageName, String tenantId) RuntimeServiceImpl.startProcessInstanceByMessageAndTenantId(String messageName, String businessKey, String tenantId) RuntimeServiceImpl.startProcessInstanceByMessageAndTenantId(String messageName, String businessKey, Map<String, Object> processVariables, String tenantId) RuntimeServiceImpl.startProcessInstanceByMessageAndTenantId(String messageName, Map<String, Object> processVariables, String tenantId) RuntimeServiceImpl.startProcessInstanceWithForm(String processDefinitionId, String outcome, Map<String, Object> variables, String processInstanceName) FormServiceImpl.submitStartFormData(String processDefinitionId, String businessKey, Map<String, String> properties) FormServiceImpl.submitStartFormData(String processDefinitionId, Map<String, String> properties) Methods in org.flowable.engine.impl that return types with arguments of type ProcessInstanceModifier and TypeMethodDescriptionNativeProcessInstanceQueryImpl.executeList(CommandContext commandContext, Map<String, Object> parameterMap) ProcessInstanceQueryImpl.executeList(CommandContext commandContext) Methods in org.flowable.engine.impl with parameters of type ProcessInstanceModifier and TypeMethodDescriptionvoidDefaultProcessLocalizationManager.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 ProcessInstanceModifier and TypeMethodDescriptionStartProcessInstanceAsyncCmd.execute(CommandContext commandContext) StartProcessInstanceByMessageCmd.execute(CommandContext commandContext) StartProcessInstanceCmd.execute(CommandContext commandContext) protected ProcessInstanceSubmitStartFormCmd.execute(CommandContext commandContext, ProcessDefinitionEntity processDefinition) protected ProcessInstanceStartProcessInstanceCmd.handleProcessInstanceWithForm(CommandContext commandContext, ProcessDefinition processDefinition, ProcessEngineConfigurationImpl processEngineConfiguration) protected ProcessInstanceStartProcessInstanceCmd.startProcessInstance(ProcessDefinition processDefinition) Methods in org.flowable.engine.impl.cmd that return types with arguments of type ProcessInstanceModifier and TypeMethodDescriptionprotected List<ProcessInstance>AbstractSetProcessDefinitionStateCmd.fetchProcessInstancesPage(CommandContext commandContext, ProcessDefinition processDefinition, int currentPageStartIndex) Methods in org.flowable.engine.impl.cmd with parameters of type ProcessInstanceModifier and TypeMethodDescriptionprotected voidAbstractDynamicInjectionCmd.createDerivedProcessDefinition(CommandContext commandContext, ProcessInstance processInstance) protected abstract AbstractSetProcessInstanceStateCmdAbstractSetProcessDefinitionStateCmd.getProcessInstanceChangeStateCmd(ProcessInstance processInstance) Subclasses should return aCommandimplementation that matches the process definition state change.protected AbstractSetProcessInstanceStateCmdActivateProcessDefinitionCmd.getProcessInstanceChangeStateCmd(ProcessInstance processInstance) protected AbstractSetProcessInstanceStateCmdSuspendProcessDefinitionCmd.getProcessInstanceChangeStateCmd(ProcessInstance processInstance) -
Uses of ProcessInstance in org.flowable.engine.impl.migration
Methods in org.flowable.engine.impl.migration with parameters of type ProcessInstanceModifier and TypeMethodDescriptionprotected voidProcessInstanceMigrationManagerImpl.changeProcessDefinitionReferenceOfHistory(ProcessInstance processInstance, ProcessDefinition processDefinition, CommandContext commandContext) protected voidProcessInstanceMigrationManagerImpl.doMigrateProcessInstance(ProcessInstance processInstance, ProcessDefinition procDefToMigrateTo, ProcessInstanceMigrationDocument document, CommandContext commandContext) protected voidProcessInstanceMigrationManagerImpl.executeExpression(ProcessInstance processInstance, ProcessDefinition procDefToMigrateTo, String preUpgradeJavaDelegateExpression, CommandContext commandContext) protected voidProcessInstanceMigrationManagerImpl.executeJavaDelegate(ProcessInstance processInstance, ProcessDefinition procDefToMigrateTo, String preUpgradeJavaDelegate, CommandContext commandContext) protected voidProcessInstanceMigrationManagerImpl.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.entityClasses in org.flowable.engine.impl.persistence.entity that implement ProcessInstanceMethods in org.flowable.engine.impl.persistence.entity that return types with arguments of type ProcessInstanceModifier and TypeMethodDescriptionExecutionEntityManager.findProcessInstanceAndVariablesByQueryCriteria(ProcessInstanceQueryImpl executionQuery) ExecutionEntityManagerImpl.findProcessInstanceAndVariablesByQueryCriteria(ProcessInstanceQueryImpl executionQuery) ExecutionEntityManager.findProcessInstanceByNativeQuery(Map<String, Object> parameterMap) ExecutionEntityManagerImpl.findProcessInstanceByNativeQuery(Map<String, Object> parameterMap) ExecutionEntityManager.findProcessInstanceByQueryCriteria(ProcessInstanceQueryImpl executionQuery) 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 ProcessInstanceModifier and TypeMethodDescriptionExecutionDataManager.findProcessInstanceAndVariablesByQueryCriteria(ProcessInstanceQueryImpl executionQuery) ExecutionDataManager.findProcessInstanceByNativeQuery(Map<String, Object> parameterMap) 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 ProcessInstanceModifier and TypeMethodDescriptionMybatisExecutionDataManager.findProcessInstanceAndVariablesByQueryCriteria(ProcessInstanceQueryImpl processInstanceQuery) MybatisExecutionDataManager.findProcessInstanceByNativeQuery(Map<String, Object> parameterMap) MybatisExecutionDataManager.findProcessInstanceByQueryCriteria(ProcessInstanceQueryImpl processInstanceQuery) -
Uses of ProcessInstance in org.flowable.engine.impl.runtime
Methods in org.flowable.engine.impl.runtime that return ProcessInstanceModifier and TypeMethodDescriptionProcessInstanceBuilderImpl.start()ProcessInstanceBuilderImpl.startAsync() -
Uses of ProcessInstance in org.flowable.engine.impl.test
Methods in org.flowable.engine.impl.test with parameters of type ProcessInstanceModifier and TypeMethodDescriptionprotected voidAbstractFlowableTestCase.assertHistoricActivitiesDeleteReason(ProcessInstance processInstance, String expectedDeleteReason, String... activityIds) protected voidAbstractFlowableTestCase.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 ProcessInstanceModifier and TypeMethodDescriptionProcessInstanceHelper.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) ProcessInstanceHelper.createAndStartProcessInstanceWithInitialFlowElement(ProcessDefinition processDefinition, String businessKey, String businessStatus, String processInstanceName, String overrideDefinitionTenantId, String predefinedProcessInstanceId, org.flowable.bpmn.model.FlowElement initialFlowElement, org.flowable.bpmn.model.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) ProcessInstanceHelper.createAndStartProcessInstanceWithInitialFlowElement(ProcessDefinition processDefinition, String businessKey, String businessStatus, String processInstanceName, org.flowable.bpmn.model.FlowElement initialFlowElement, org.flowable.bpmn.model.Process process, Map<String, Object> variables, Map<String, Object> transientVariables, String ownerId, String assigneeId, boolean startProcessInstance) 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) 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 ProcessInstanceModifier and TypeMethodDescriptionvoidProcessInstanceHelper.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 ProcessInstanceModifier and TypeMethodDescriptionvoidProcessInstanceQueryInterceptor.afterProcessInstanceQueryExecute(ProcessInstanceQuery processInstanceQuery, List<ProcessInstance> processInstances) -
Uses of ProcessInstance in org.flowable.engine.migration
Methods in org.flowable.engine.migration with parameters of type ProcessInstanceModifier and TypeMethodDescriptionvoidProcessInstanceMigrationCallback.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 ProcessInstanceModifier and TypeMethodDescriptionProcessInstanceBuilder.start()Start the process instanceProcessInstanceBuilder.startAsync()Start the process instance asynchronously