| Package | Description |
|---|---|
| org.camunda.bpm.engine |
Public API of the camunda BPM 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 DeploymentsRuntimeService:
For starting and searching ProcessInstancesTaskService:
Exposes operations to manage human (standalone) Tasks,
such as claiming, completing and assigning tasksIdentityService:
Used for managing Users,
Groups and the relations between themManagementService:
Exposes engine admin and maintenance operations,
which have no relation to the runtime execution of business processesHistoryService:
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.rest.dto.runtime | |
| org.camunda.bpm.engine.rest.sub.repository.impl | |
| org.camunda.bpm.engine.runtime |
Classes related to the
RuntimeService. |
| Modifier and Type | Method and 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,
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)
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,
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.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,
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)
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,
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.startProcessInstanceByMessage(String messageName)
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.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.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,
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,
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 |
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.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.submitStartFormData(String processDefinitionId,
Map<String,String> properties)
Deprecated.
|
ProcessInstance |
FormService.submitStartFormData(String processDefinitionId,
String businessKey,
Map<String,String> properties)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
ProcessInstance |
CurrentProcessInstance.getProcessInstance()
Returns the
ProcessInstance currently associated or 'null' |
ProcessInstance |
BusinessProcess.getProcessInstance()
Returns the
ProcessInstance currently associated or 'null' |
ProcessInstance |
BusinessProcess.startProcessById(String processDefinitionId) |
ProcessInstance |
BusinessProcess.startProcessById(String processDefinitionId,
Map<String,Object> variables) |
ProcessInstance |
BusinessProcess.startProcessById(String processDefinitionId,
String businessKey) |
ProcessInstance |
BusinessProcess.startProcessById(String processDefinitionId,
String businessKey,
Map<String,Object> variables) |
ProcessInstance |
BusinessProcess.startProcessByKey(String key) |
ProcessInstance |
BusinessProcess.startProcessByKey(String key,
Map<String,Object> variables) |
ProcessInstance |
BusinessProcess.startProcessByKey(String key,
String businessKey) |
ProcessInstance |
BusinessProcess.startProcessByKey(String key,
String businessKey,
Map<String,Object> variables) |
ProcessInstance |
BusinessProcess.startProcessByMessage(String messageName) |
ProcessInstance |
BusinessProcess.startProcessByMessage(String messageName,
Map<String,Object> processVariables) |
ProcessInstance |
BusinessProcess.startProcessByMessage(String messageName,
String businessKey,
Map<String,Object> processVariables) |
| Modifier and Type | Method and Description |
|---|---|
String |
BusinessKeyProducer.businessKey(ProcessInstance processInstance) |
| Modifier and Type | Method and Description |
|---|---|
ProcessInstance |
ProcessInstantiationBuilderImpl.execute() |
ProcessInstance |
ProcessInstantiationBuilderImpl.execute(boolean skipCustomListeners,
boolean skipIoMappings) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId,
Map<String,Object> variables) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId,
String businessKey) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId,
String businessKey,
Map<String,Object> variables) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId,
String businessKey,
String caseInstanceId) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceById(String processDefinitionId,
String businessKey,
String caseInstanceId,
Map<String,Object> variables) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceByKey(String processDefinitionKey) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceByKey(String processDefinitionKey,
Map<String,Object> variables) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceByKey(String processDefinitionKey,
String businessKey) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceByKey(String processDefinitionKey,
String businessKey,
Map<String,Object> variables) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceByKey(String processDefinitionKey,
String businessKey,
String caseInstanceId) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceByKey(String processDefinitionKey,
String businessKey,
String caseInstanceId,
Map<String,Object> variables) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceByMessage(String messageName) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceByMessage(String messageName,
Map<String,Object> processVariables) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceByMessage(String messageName,
String businessKey) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceByMessage(String messageName,
String businessKey,
Map<String,Object> processVariables) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceByMessageAndProcessDefinitionId(String messageName,
String processDefinitionId) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceByMessageAndProcessDefinitionId(String messageName,
String processDefinitionId,
Map<String,Object> processVariables) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceByMessageAndProcessDefinitionId(String messageName,
String processDefinitionId,
String businessKey) |
ProcessInstance |
RuntimeServiceImpl.startProcessInstanceByMessageAndProcessDefinitionId(String messageName,
String processDefinitionId,
String businessKey,
Map<String,Object> processVariables) |
ProcessInstance |
FormServiceImpl.submitStartForm(String processDefinitionId,
Map<String,Object> properties) |
ProcessInstance |
FormServiceImpl.submitStartForm(String processDefinitionId,
String businessKey,
Map<String,Object> properties) |
ProcessInstance |
FormServiceImpl.submitStartFormData(String processDefinitionId,
Map<String,String> properties) |
ProcessInstance |
FormServiceImpl.submitStartFormData(String processDefinitionId,
String businessKey,
Map<String,String> properties) |
| Modifier and Type | Method and Description |
|---|---|
List<ProcessInstance> |
NativeProcessInstanceQueryImpl.executeList(CommandContext commandContext,
Map<String,Object> parameterMap,
int firstResult,
int maxResults) |
List<ProcessInstance> |
ProcessInstanceQueryImpl.executeList(CommandContext commandContext,
Page page) |
| Modifier and Type | Method and Description |
|---|---|
AuthorizationEntity[] |
DefaultAuthorizationProvider.newProcessInstance(ProcessInstance processInstance) |
AuthorizationEntity[] |
ResourceAuthorizationProvider.newProcessInstance(ProcessInstance processInstance)
Invoked whenever a new process instance is started
|
| Modifier and Type | Method and Description |
|---|---|
ProcessInstance |
SubmitStartFormCmd.execute(CommandContext commandContext) |
ProcessInstance |
StartProcessInstanceByMessageCmd.execute(CommandContext commandContext) |
ProcessInstance |
StartProcessInstanceAtActivitiesCmd.execute(CommandContext commandContext) |
ProcessInstance |
StartProcessInstanceCmd.execute(CommandContext commandContext) |
ProcessInstance |
StartProcessInstanceByMessageAndProcessDefinitionIdCmd.execute(CommandContext commandContext) |
| Modifier and Type | Class and Description |
|---|---|
class |
ExecutionEntity |
| Modifier and Type | Method and Description |
|---|---|
List<ProcessInstance> |
ExecutionManager.findProcessInstanceByNativeQuery(Map<String,Object> parameterMap,
int firstResult,
int maxResults) |
List<ProcessInstance> |
ExecutionManager.findProcessInstanceByQueryCriteria(ProcessInstanceQueryImpl processInstanceQuery,
Page page) |
| Modifier and Type | Method and Description |
|---|---|
static ProcessInstanceDto |
ProcessInstanceDto.fromProcessInstance(ProcessInstance instance) |
| Modifier and Type | Method and Description |
|---|---|
protected ProcessInstance |
ProcessDefinitionResourceImpl.startProcessInstance(StartProcessInstanceDto dto) |
protected ProcessInstance |
ProcessDefinitionResourceImpl.startProcessInstanceAtActivities(StartProcessInstanceDto dto) |
| Modifier and Type | Method and Description |
|---|---|
ProcessInstance |
ProcessInstantiationBuilder.execute()
Start the process instance by executing all instructions in the order they are submitted.
|
ProcessInstance |
ProcessInstantiationBuilder.execute(boolean skipCustomListeners,
boolean skipIoMappings)
Start the process instance by executing all instructions in the order they are submitted.
|
Copyright © 2018. All rights reserved.