| 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.compatibility | |
| org.flowable.engine.form |
Classes related to the
FormService. |
| org.flowable.engine.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
| org.flowable.engine.impl.bpmn.behavior | |
| org.flowable.engine.impl.cmd | |
| org.flowable.engine.impl.context | |
| org.flowable.engine.impl.dynamic | |
| org.flowable.engine.impl.form | |
| org.flowable.engine.impl.migration | |
| org.flowable.engine.impl.persistence.deploy | |
| 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.test | |
| org.flowable.engine.impl.util |
| Modifier and Type | Method and Description |
|---|---|
ProcessDefinition |
RepositoryService.getProcessDefinition(String processDefinitionId)
Returns the
ProcessDefinition including all BPMN information like additional Properties (e.g. |
| Modifier and Type | Method and Description |
|---|---|
ProcessDefinition |
Flowable5CompatibilityHandler.getProcessDefinition(String processDefinitionId) |
ProcessDefinition |
Flowable5CompatibilityHandler.getProcessDefinitionByKey(String processDefinitionKey) |
| Modifier and Type | Method and Description |
|---|---|
ProcessDefinitionCacheEntry |
Flowable5CompatibilityHandler.resolveProcessDefinition(ProcessDefinition processDefinition) |
| Modifier and Type | Method and Description |
|---|---|
ProcessDefinition |
StartFormData.getProcessDefinition()
The process definition for which this form is starting a new process instance
|
| Modifier and Type | Method and Description |
|---|---|
ProcessDefinition |
RepositoryServiceImpl.getDeployedProcessDefinition(String processDefinitionId) |
ProcessDefinition |
RepositoryServiceImpl.getProcessDefinition(String processDefinitionId) |
| Modifier and Type | Method and Description |
|---|---|
List<ProcessDefinition> |
ProcessDefinitionQueryImpl.executeList(CommandContext commandContext) |
List<ProcessDefinition> |
NativeProcessDefinitionQueryImpl.executeList(CommandContext commandContext,
Map<String,Object> parameterMap) |
| Modifier and Type | Method and Description |
|---|---|
protected ProcessDefinition |
CallActivityBehavior.findProcessDefinitionByKey(String processDefinitionKey,
String processDefinitionId,
String tenantId,
boolean sameDeployment) |
protected ProcessDefinition |
CallActivityBehavior.getProcessDefinitionById(DelegateExecution execution) |
protected ProcessDefinition |
CallActivityBehavior.getProcessDefinitionByKey(DelegateExecution execution,
boolean isSameDeployment) |
| Modifier and Type | Method and Description |
|---|---|
ProcessDefinition |
GetDeploymentProcessDefinitionCmd.execute(CommandContext commandContext) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
GetDecisionTablesForProcessDefinitionCmd.addDecisionTableToCollection(List<DmnDecisionTable> decisionTables,
String decisionTableKey,
ProcessDefinition processDefinition) |
protected void |
GetFormDefinitionsForProcessDefinitionCmd.addFormDefinitionToCollection(List<FormDefinition> formDefinitions,
String formKey,
ProcessDefinition processDefinition) |
protected ProcessInstance |
StartProcessInstanceWithFormCmd.createAndStartProcessInstance(ProcessDefinition processDefinition,
String processInstanceName,
Map<String,Object> variables,
CommandContext commandContext) |
protected List<ProcessInstance> |
AbstractSetProcessDefinitionStateCmd.fetchProcessInstancesPage(CommandContext commandContext,
ProcessDefinition processDefinition,
int currentPageStartIndex) |
protected List<DmnDecisionTable> |
GetDecisionTablesForProcessDefinitionCmd.getDecisionTablesFromModel(org.flowable.bpmn.model.BpmnModel bpmnModel,
ProcessDefinition processDefinition) |
protected List<FormDefinition> |
GetFormDefinitionsForProcessDefinitionCmd.getFormDefinitionsFromModel(org.flowable.bpmn.model.BpmnModel bpmnModel,
ProcessDefinition processDefinition) |
protected void |
SetProcessDefinitionVersionCmd.validateAndSwitchVersionOfExecution(CommandContext commandContext,
ExecutionEntity execution,
ProcessDefinition newProcessDefinition) |
| Modifier and Type | Method and Description |
|---|---|
ProcessDefinition |
ExecutionContext.getProcessDefinition() |
| Modifier and Type | Field and Description |
|---|---|
protected ProcessDefinition |
ProcessInstanceChangeState.processDefinitionToMigrateTo |
protected ProcessDefinition |
MoveExecutionEntityContainer.subProcessDefinition |
| Modifier and Type | Method and Description |
|---|---|
ProcessDefinition |
MoveExecutionEntityContainer.getSubProcessDefinition() |
| Modifier and Type | Method and Description |
|---|---|
Optional<ProcessDefinition> |
ProcessInstanceChangeState.getProcessDefinitionToMigrateTo() |
| Modifier and Type | Method and Description |
|---|---|
protected ExecutionEntity |
AbstractDynamicStateManager.createCallActivityInstance(org.flowable.bpmn.model.CallActivity callActivity,
ProcessDefinition subProcessDefinition,
ExecutionEntity parentExecution,
org.flowable.bpmn.model.FlowElement initialFlowElement,
CommandContext commandContext) |
protected static void |
BaseDynamicSubProcessInjectUtil.processDecisionTask(org.flowable.bpmn.model.FlowElement flowElement,
ProcessDefinition originalProcessDefinitionEntity,
DeploymentEntity newDeploymentEntity,
CommandContext commandContext) |
protected static void |
BaseDynamicSubProcessInjectUtil.processSubProcessFlowElements(CommandContext commandContext,
String prefix,
org.flowable.bpmn.model.Process process,
org.flowable.bpmn.model.BpmnModel bpmnModel,
org.flowable.bpmn.model.SubProcess subProcess,
org.flowable.bpmn.model.BpmnModel subProcessBpmnModel,
ProcessDefinition originalProcessDefinition,
DeploymentEntity newDeploymentEntity,
Map<String,org.flowable.bpmn.model.FlowElement> generatedIds,
boolean includeDiInfo) |
protected static void |
BaseDynamicSubProcessInjectUtil.processUserTask(org.flowable.bpmn.model.FlowElement flowElement,
ProcessDefinition originalProcessDefinitionEntity,
DeploymentEntity newDeploymentEntity,
CommandContext commandContext) |
ProcessInstanceChangeState |
ProcessInstanceChangeState.setProcessDefinitionToMigrateTo(ProcessDefinition processDefinitionToMigrateTo) |
void |
MoveExecutionEntityContainer.setSubProcessDefinition(ProcessDefinition subProcessDefinition) |
| Modifier and Type | Field and Description |
|---|---|
protected ProcessDefinition |
StartFormDataImpl.processDefinition |
| Modifier and Type | Method and Description |
|---|---|
ProcessDefinition |
StartFormDataImpl.getProcessDefinition() |
| Modifier and Type | Method and Description |
|---|---|
StartFormData |
StartFormHandler.createStartFormData(ProcessDefinition processDefinition) |
StartFormData |
DefaultStartFormHandler.createStartFormData(ProcessDefinition processDefinition) |
StartFormHandler |
FormHandlerHelper.getStartFormHandler(CommandContext commandContext,
ProcessDefinition processDefinition) |
void |
FormHandler.parseConfiguration(List<org.flowable.bpmn.model.FormProperty> formProperties,
String formKey,
DeploymentEntity deployment,
ProcessDefinition processDefinition) |
void |
DefaultStartFormHandler.parseConfiguration(List<org.flowable.bpmn.model.FormProperty> formProperties,
String formKey,
DeploymentEntity deployment,
ProcessDefinition processDefinition) |
void |
DefaultFormHandler.parseConfiguration(List<org.flowable.bpmn.model.FormProperty> formProperties,
String formKey,
DeploymentEntity deployment,
ProcessDefinition processDefinition) |
void |
StartFormDataImpl.setProcessDefinition(ProcessDefinition processDefinition) |
| Modifier and Type | Method and Description |
|---|---|
protected ProcessDefinition |
ProcessInstanceMigrationManagerImpl.resolveProcessDefinition(ProcessInstanceMigrationDocument document,
CommandContext commandContext) |
protected ProcessDefinition |
ProcessInstanceMigrationManagerImpl.resolveProcessDefinition(String processDefinitionKey,
int processDefinitionVersion,
String processDefinitionTenantId,
CommandContext commandContext) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
ProcessInstanceMigrationManagerImpl.changeProcessDefinitionReferenceOfHistory(ProcessInstance processInstance,
ProcessDefinition processDefinition,
CommandContext commandContext) |
protected void |
ProcessInstanceMigrationManagerImpl.doMigrateProcessInstance(String processInstanceId,
ProcessDefinition procDefToMigrateTo,
org.flowable.bpmn.model.BpmnModel bpmnModel,
ProcessInstanceMigrationDocument document,
CommandContext commandContext) |
protected ChangeActivityStateBuilderImpl |
ProcessInstanceMigrationManagerImpl.prepareChangeStateBuilder(String processInstanceId,
ProcessDefinition procDefToMigrateTo,
org.flowable.bpmn.model.BpmnModel bpmnModel,
ProcessInstanceMigrationDocument document,
CommandContext commandContext) |
| Modifier and Type | Field and Description |
|---|---|
protected ProcessDefinition |
ProcessDefinitionCacheEntry.processDefinition |
| Modifier and Type | Method and Description |
|---|---|
ProcessDefinition |
DeploymentManager.findDeployedLatestProcessDefinitionByKey(String processDefinitionKey) |
ProcessDefinition |
DeploymentManager.findDeployedLatestProcessDefinitionByKeyAndTenantId(String processDefinitionKey,
String tenantId) |
ProcessDefinition |
DeploymentManager.findDeployedProcessDefinitionById(String processDefinitionId) |
ProcessDefinition |
DeploymentManager.findDeployedProcessDefinitionByKeyAndVersionAndTenantId(String processDefinitionKey,
Integer processDefinitionVersion,
String tenantId) |
ProcessDefinition |
ProcessDefinitionCacheEntry.getProcessDefinition() |
| Modifier and Type | Method and Description |
|---|---|
ProcessDefinitionCacheEntry |
DeploymentManager.resolveProcessDefinition(ProcessDefinition processDefinition)
Resolving the process definition will fetch the BPMN 2.0, parse it and store the
BpmnModel in memory. |
void |
ProcessDefinitionCacheEntry.setProcessDefinition(ProcessDefinition processDefinition) |
| Constructor and Description |
|---|
ProcessDefinitionCacheEntry(ProcessDefinition processDefinition,
org.flowable.bpmn.model.BpmnModel bpmnModel,
org.flowable.bpmn.model.Process process) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ProcessDefinitionEntity |
| Modifier and Type | Class and Description |
|---|---|
class |
ProcessDefinitionEntityImpl |
| Modifier and Type | Method and Description |
|---|---|
protected ProcessDefinition |
DeploymentEntityManagerImpl.findNewLatestProcessDefinitionAfterRemovalOf(ProcessDefinition processDefinitionToBeRemoved) |
ProcessDefinition |
ProcessDefinitionEntityManagerImpl.findProcessDefinitionByKeyAndVersionAndTenantId(String processDefinitionKey,
Integer processDefinitionVersion,
String tenantId) |
ProcessDefinition |
ProcessDefinitionEntityManager.findProcessDefinitionByKeyAndVersionAndTenantId(String processDefinitionKey,
Integer processDefinitionVersion,
String tenantId) |
| Modifier and Type | Method and Description |
|---|---|
List<ProcessDefinition> |
ProcessDefinitionEntityManagerImpl.findProcessDefinitionsByNativeQuery(Map<String,Object> parameterMap) |
List<ProcessDefinition> |
ProcessDefinitionEntityManager.findProcessDefinitionsByNativeQuery(Map<String,Object> parameterMap) |
List<ProcessDefinition> |
ProcessDefinitionEntityManagerImpl.findProcessDefinitionsByQueryCriteria(ProcessDefinitionQueryImpl processDefinitionQuery) |
List<ProcessDefinition> |
ProcessDefinitionEntityManager.findProcessDefinitionsByQueryCriteria(ProcessDefinitionQueryImpl processDefinitionQuery) |
| Modifier and Type | Method and Description |
|---|---|
ExecutionEntity |
ExecutionEntityManagerImpl.createProcessInstanceExecution(ProcessDefinition processDefinition,
String businessKey,
String tenantId,
String initiatorVariableName,
String startActivityId) |
ExecutionEntity |
ExecutionEntityManager.createProcessInstanceExecution(ProcessDefinition processDefinition,
String businessKey,
String tenantId,
String initiatorVariableName,
String startActivityId) |
ExecutionEntity |
ExecutionEntityManagerImpl.createSubprocessInstance(ProcessDefinition processDefinition,
ExecutionEntity superExecutionEntity,
String businessKey,
String activityId) |
ExecutionEntity |
ExecutionEntityManager.createSubprocessInstance(ProcessDefinition processDefinition,
ExecutionEntity superExecutionEntity,
String businessKey,
String startActivityId) |
protected void |
DeploymentEntityManagerImpl.deleteEventSubscriptions(ProcessDefinition processDefinition) |
protected void |
DeploymentEntityManagerImpl.deleteProcessDefinitionIdentityLinks(ProcessDefinition processDefinition) |
protected ProcessDefinitionEntity |
DeploymentEntityManagerImpl.findLatestProcessDefinition(ProcessDefinition processDefinition) |
protected ProcessDefinition |
DeploymentEntityManagerImpl.findNewLatestProcessDefinitionAfterRemovalOf(ProcessDefinition processDefinitionToBeRemoved) |
protected void |
DeploymentEntityManagerImpl.removeTimerStartJobs(ProcessDefinition processDefinition) |
protected void |
DeploymentEntityManagerImpl.restoreMessageStartEvent(ProcessDefinition previousProcessDefinition,
org.flowable.bpmn.model.BpmnModel bpmnModel,
org.flowable.bpmn.model.StartEvent startEvent,
org.flowable.bpmn.model.EventDefinition eventDefinition) |
protected void |
DeploymentEntityManagerImpl.restorePreviousStartEventsIfNeeded(ProcessDefinition processDefinition) |
protected void |
DeploymentEntityManagerImpl.restoreSignalStartEvent(ProcessDefinition previousProcessDefinition,
org.flowable.bpmn.model.BpmnModel bpmnModel,
org.flowable.bpmn.model.StartEvent startEvent,
org.flowable.bpmn.model.EventDefinition eventDefinition) |
protected void |
DeploymentEntityManagerImpl.restoreTimerStartEvent(ProcessDefinition previousProcessDefinition,
org.flowable.bpmn.model.StartEvent startEvent,
org.flowable.bpmn.model.EventDefinition eventDefinition) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
DeploymentEntityManagerImpl.deleteProcessInstancesForProcessDefinitions(List<ProcessDefinition> processDefinitions) |
| Modifier and Type | Method and Description |
|---|---|
List<ProcessDefinition> |
ProcessDefinitionDataManager.findProcessDefinitionsByNativeQuery(Map<String,Object> parameterMap) |
List<ProcessDefinition> |
ProcessDefinitionDataManager.findProcessDefinitionsByQueryCriteria(ProcessDefinitionQueryImpl processDefinitionQuery) |
| Modifier and Type | Method and Description |
|---|---|
List<ProcessDefinition> |
MybatisProcessDefinitionDataManager.findProcessDefinitionsByNativeQuery(Map<String,Object> parameterMap) |
List<ProcessDefinition> |
MybatisProcessDefinitionDataManager.findProcessDefinitionsByQueryCriteria(ProcessDefinitionQueryImpl processDefinitionQuery) |
| Modifier and Type | Method and Description |
|---|---|
protected ProcessDefinition |
AbstractFlowableTestCase.deployProcessDefinition(String name,
String path) |
| Modifier and Type | Method and Description |
|---|---|
static ProcessDefinition |
ProcessDefinitionUtil.getProcessDefinition(String processDefinitionId) |
static ProcessDefinition |
ProcessDefinitionUtil.getProcessDefinition(String processDefinitionId,
boolean checkCacheOnly) |
| Modifier and Type | Method and Description |
|---|---|
ProcessInstance |
ProcessInstanceHelper.createAndStartProcessInstance(ProcessDefinition processDefinition,
String businessKey,
String processInstanceName,
Map<String,Object> variables,
Map<String,Object> transientVariables) |
ProcessInstance |
ProcessInstanceHelper.createAndStartProcessInstanceByMessage(ProcessDefinition processDefinition,
String messageName,
String businessKey,
Map<String,Object> variables,
Map<String,Object> transientVariables,
String callbackId,
String callbackType) |
ProcessInstance |
ProcessInstanceHelper.createAndStartProcessInstanceWithInitialFlowElement(ProcessDefinition processDefinition,
String businessKey,
String processInstanceName,
org.flowable.bpmn.model.FlowElement initialFlowElement,
org.flowable.bpmn.model.Process process,
Map<String,Object> variables,
Map<String,Object> transientVariables,
boolean startProcessInstance) |
ProcessInstance |
ProcessInstanceHelper.createAndStartProcessInstanceWithInitialFlowElement(ProcessDefinition processDefinition,
String businessKey,
String processInstanceName,
String overrideDefinitionTenantId,
org.flowable.bpmn.model.FlowElement initialFlowElement,
org.flowable.bpmn.model.Process process,
Map<String,Object> variables,
Map<String,Object> transientVariables,
String callbackId,
String callbackType,
boolean startProcessInstance) |
ProcessInstance |
ProcessInstanceHelper.createProcessInstance(ProcessDefinition processDefinition,
String businessKey,
String processInstanceName,
Map<String,Object> variables,
Map<String,Object> transientVariables) |
ProcessInstance |
ProcessInstanceHelper.createProcessInstance(ProcessDefinition processDefinition,
String businessKey,
String processInstanceName,
String overrideDefinitionTenantId,
Map<String,Object> variables,
Map<String,Object> transientVariables,
String callbackId,
String callbackType,
boolean startProcessInstance) |
static boolean |
Flowable5Util.isFlowable5ProcessDefinition(ProcessDefinition processDefinition,
CommandContext commandContext) |
static boolean |
Flowable5Util.isFlowable5ProcessDefinition(ProcessDefinition processDefinition,
ProcessEngineConfigurationImpl processEngineConfiguration) |
Copyright © 2018 Flowable. All rights reserved.