| 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) org.flowable.engine.task.Tasks,
such as claiming, completing and assigning tasks.IdentityService: Used for managing Users,
identity.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.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
| org.flowable.engine.impl.runtime | |
| org.flowable.engine.runtime |
Classes related to the
RuntimeService. |
| Modifier and Type | Method and Description |
|---|---|
ProcessInstanceBuilder |
RuntimeService.createProcessInstanceBuilder()
Create a
ProcessInstanceBuilder, that allows to set various options for starting a process instance, as an alternative to the various startProcessInstanceByXX methods. |
| Modifier and Type | Method and Description |
|---|---|
ProcessInstanceBuilder |
RuntimeServiceImpl.createProcessInstanceBuilder() |
| Modifier and Type | Class and Description |
|---|---|
class |
ProcessInstanceBuilderImpl |
| Modifier and Type | Method and Description |
|---|---|
ProcessInstanceBuilder |
ProcessInstanceBuilderImpl.businessKey(String businessKey) |
ProcessInstanceBuilder |
ProcessInstanceBuilderImpl.callbackId(String callbackId) |
ProcessInstanceBuilder |
ProcessInstanceBuilderImpl.callbackType(String callbackType) |
ProcessInstanceBuilder |
ProcessInstanceBuilderImpl.messageName(String messageName) |
ProcessInstanceBuilder |
ProcessInstanceBuilderImpl.name(String processInstanceName) |
ProcessInstanceBuilder |
ProcessInstanceBuilderImpl.processDefinitionId(String processDefinitionId) |
ProcessInstanceBuilder |
ProcessInstanceBuilderImpl.processDefinitionKey(String processDefinitionKey) |
ProcessInstanceBuilder |
ProcessInstanceBuilderImpl.tenantId(String tenantId) |
ProcessInstanceBuilder |
ProcessInstanceBuilderImpl.transientVariable(String variableName,
Object value) |
ProcessInstanceBuilder |
ProcessInstanceBuilderImpl.transientVariables(Map<String,Object> transientVariables) |
ProcessInstanceBuilder |
ProcessInstanceBuilderImpl.variable(String variableName,
Object value) |
ProcessInstanceBuilder |
ProcessInstanceBuilderImpl.variables(Map<String,Object> variables) |
| Modifier and Type | Method and Description |
|---|---|
ProcessInstanceBuilder |
ProcessInstanceBuilder.businessKey(String businessKey)
Set the businessKey of process instance
|
ProcessInstanceBuilder |
ProcessInstanceBuilder.callbackId(String callbackId)
Sets the callback identifier of the process instance.
|
ProcessInstanceBuilder |
ProcessInstanceBuilder.callbackType(String callbackType)
Sets the callback type of the process instance.
|
ProcessInstanceBuilder |
ProcessInstanceBuilder.messageName(String messageName)
Set the message name that needs to be used to look up the process definition that needs to be used to start the process instance.
|
ProcessInstanceBuilder |
ProcessInstanceBuilder.name(String processInstanceName)
Set the name of process instance
|
ProcessInstanceBuilder |
ProcessInstanceBuilder.processDefinitionId(String processDefinitionId)
Set the id of the process definition
|
ProcessInstanceBuilder |
ProcessInstanceBuilder.processDefinitionKey(String processDefinitionKey)
Set the key of the process definition, latest version of the process definition with the given key.
|
ProcessInstanceBuilder |
ProcessInstanceBuilder.tenantId(String tenantId)
Set the tenantId of process instance
|
ProcessInstanceBuilder |
ProcessInstanceBuilder.transientVariable(String variableName,
Object value)
Adds a transient variable to the process instance
|
ProcessInstanceBuilder |
ProcessInstanceBuilder.transientVariables(Map<String,Object> transientVariables)
Sets the transient variables
|
ProcessInstanceBuilder |
ProcessInstanceBuilder.variable(String variableName,
Object value)
Adds a variable to the process instance
|
ProcessInstanceBuilder |
ProcessInstanceBuilder.variables(Map<String,Object> variables)
Sets the process variables
|
Copyright © 2017 Flowable. All rights reserved.