| Package | Description |
|---|---|
| org.flowable.batch.api | |
| org.flowable.batch.service.impl | |
| org.flowable.batch.service.impl.persistence.entity | |
| org.flowable.batch.service.impl.persistence.entity.data | |
| org.flowable.batch.service.impl.persistence.entity.data.impl | |
| org.flowable.cmmn.api | |
| org.flowable.cmmn.api.migration | |
| org.flowable.cmmn.engine.impl.cmd | |
| org.flowable.cmmn.engine.impl.migration | |
| 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.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
| org.flowable.engine.impl.cmd | |
| org.flowable.engine.impl.jobexecutor | |
| org.flowable.engine.impl.migration | |
| org.flowable.engine.migration | |
| org.flowable.rest.service.api | |
| org.flowable.rest.service.api.management |
| Modifier and Type | Method and Description |
|---|---|
Batch |
BatchBuilder.create() |
Batch |
BatchService.getBatch(String id) |
Batch |
BatchService.updateBatch(Batch batch) |
| Modifier and Type | Method and Description |
|---|---|
List<Batch> |
BatchService.findBatchesByQueryCriteria(BatchQuery batchQuery) |
List<Batch> |
BatchService.findBatchesBySearchKey(String searchKey) |
List<Batch> |
BatchService.getAllBatches() |
| Modifier and Type | Method and Description |
|---|---|
BatchPart |
BatchService.createBatchPart(Batch batch,
String status,
String scopeId,
String subScopeId,
String scopeType) |
void |
BatchService.insertBatch(Batch batch) |
Batch |
BatchService.updateBatch(Batch batch) |
| Modifier and Type | Method and Description |
|---|---|
Batch |
BatchBuilderImpl.create() |
Batch |
BatchServiceImpl.createBatch(BatchBuilder batchBuilder) |
Batch |
BatchServiceImpl.updateBatch(Batch batch) |
| Modifier and Type | Method and Description |
|---|---|
List<Batch> |
BatchQueryImpl.executeList(CommandContext commandContext) |
List<Batch> |
BatchServiceImpl.findBatchesByQueryCriteria(BatchQuery batchQuery) |
List<Batch> |
BatchServiceImpl.findBatchesBySearchKey(String searchKey) |
List<Batch> |
BatchServiceImpl.getAllBatches() |
| Modifier and Type | Method and Description |
|---|---|
BatchPart |
BatchServiceImpl.createBatchPart(Batch batch,
String status,
String scopeId,
String subScopeId,
String scopeType) |
void |
BatchServiceImpl.insertBatch(Batch batch) |
Batch |
BatchServiceImpl.updateBatch(Batch batch) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
BatchEntity |
| Modifier and Type | Class and Description |
|---|---|
class |
BatchEntityImpl |
| Modifier and Type | Method and Description |
|---|---|
Batch |
BatchEntityManager.createBatch(BatchBuilder batchBuilder) |
| Modifier and Type | Method and Description |
|---|---|
List<Batch> |
BatchEntityManagerImpl.findAllBatches() |
List<Batch> |
BatchEntityManager.findAllBatches() |
List<Batch> |
BatchEntityManagerImpl.findBatchesByQueryCriteria(BatchQueryImpl batchQuery) |
List<Batch> |
BatchEntityManager.findBatchesByQueryCriteria(BatchQueryImpl batchQuery) |
List<Batch> |
BatchEntityManagerImpl.findBatchesBySearchKey(String searchKey) |
List<Batch> |
BatchEntityManager.findBatchesBySearchKey(String searchKey) |
| Modifier and Type | Method and Description |
|---|---|
List<Batch> |
BatchDataManager.findAllBatches() |
List<Batch> |
BatchDataManager.findBatchesByQueryCriteria(BatchQueryImpl batchQuery) |
List<Batch> |
BatchDataManager.findBatchesBySearchKey(String searchKey) |
| Modifier and Type | Method and Description |
|---|---|
List<Batch> |
MybatisBatchDataManager.findAllBatches() |
List<Batch> |
MybatisBatchDataManager.findBatchesByQueryCriteria(BatchQueryImpl batchQuery) |
List<Batch> |
MybatisBatchDataManager.findBatchesBySearchKey(String searchKey) |
| Modifier and Type | Method and Description |
|---|---|
Batch |
CmmnMigrationService.batchMigrateCaseInstancesOfCaseDefinition(String caseDefinitionId,
CaseInstanceMigrationDocument caseInstanceMigrationDocument) |
Batch |
CmmnMigrationService.batchMigrateCaseInstancesOfCaseDefinition(String caseDefinitionKey,
int caseDefinitionVersion,
String caseDefinitionTenantId,
CaseInstanceMigrationDocument caseInstanceMigrationDocument) |
| Modifier and Type | Method and Description |
|---|---|
Batch |
CaseInstanceMigrationBuilder.batchMigrateCaseInstances(String caseDefinitionId)
Starts the case instance migration for all case instances of a given case definition identified by the case definition id.
|
Batch |
CaseInstanceMigrationBuilder.batchMigrateCaseInstances(String caseDefinitionKey,
int caseDefinitionVersion,
String caseDefinitionTenantId)
Asynchronously starts the case instance migration for each case instances of a given case definition identified by the case definition key and version (optional tenantId).
|
| Modifier and Type | Method and Description |
|---|---|
Batch |
CaseInstanceMigrationBatchCmd.execute(CommandContext commandContext) |
| Modifier and Type | Method and Description |
|---|---|
Batch |
CaseInstanceMigrationBuilderImpl.batchMigrateCaseInstances(String caseDefinitionId) |
Batch |
CaseInstanceMigrationBuilderImpl.batchMigrateCaseInstances(String caseDefinitionKey,
int caseDefinitionVersion,
String caseDefinitionTenantId) |
Batch |
CmmnMigrationServiceImpl.batchMigrateCaseInstancesOfCaseDefinition(String caseDefinitionId,
CaseInstanceMigrationDocument caseInstanceMigrationDocument) |
Batch |
CaseInstanceMigrationManagerImpl.batchMigrateCaseInstancesOfCaseDefinition(String caseDefinitionId,
CaseInstanceMigrationDocument document,
CommandContext commandContext) |
Batch |
CaseInstanceMigrationManager.batchMigrateCaseInstancesOfCaseDefinition(String caseDefinitionId,
CaseInstanceMigrationDocument document,
CommandContext commandContext) |
Batch |
CmmnMigrationServiceImpl.batchMigrateCaseInstancesOfCaseDefinition(String caseDefinitionKey,
int caseDefinitionVersion,
String caseDefinitionTenantId,
CaseInstanceMigrationDocument caseInstanceMigrationDocument) |
Batch |
CaseInstanceMigrationManagerImpl.batchMigrateCaseInstancesOfCaseDefinition(String caseDefinitionKey,
int caseDefinitionVersion,
String caseDefinitionTenantId,
CaseInstanceMigrationDocument document,
CommandContext commandContext) |
Batch |
CaseInstanceMigrationManager.batchMigrateCaseInstancesOfCaseDefinition(String caseDefinitionKey,
int caseDefinitionVersion,
String caseDefinitionTenantId,
CaseInstanceMigrationDocument document,
CommandContext commandContext) |
| Modifier and Type | Method and Description |
|---|---|
Batch |
ProcessMigrationService.batchMigrateProcessInstancesOfProcessDefinition(String processDefinitionKey,
int processDefinitionVersion,
String processDefinitionTenantId,
ProcessInstanceMigrationDocument processInstanceMigrationDocument) |
Batch |
ProcessMigrationService.batchMigrateProcessInstancesOfProcessDefinition(String processDefinitionId,
ProcessInstanceMigrationDocument processInstanceMigrationDocument) |
| Modifier and Type | Method and Description |
|---|---|
List<Batch> |
ManagementService.findBatchesBySearchKey(String searchKey) |
List<Batch> |
ManagementService.getAllBatches() |
| Modifier and Type | Method and Description |
|---|---|
Batch |
ProcessMigrationServiceImpl.batchMigrateProcessInstancesOfProcessDefinition(String processDefinitionKey,
int processDefinitionVersion,
String processDefinitionTenantId,
ProcessInstanceMigrationDocument processInstanceMigrationDocument) |
Batch |
ProcessMigrationServiceImpl.batchMigrateProcessInstancesOfProcessDefinition(String processDefinitionId,
ProcessInstanceMigrationDocument processInstanceMigrationDocument) |
| Modifier and Type | Method and Description |
|---|---|
List<Batch> |
ManagementServiceImpl.findBatchesBySearchKey(String searchKey) |
List<Batch> |
ManagementServiceImpl.getAllBatches() |
| Modifier and Type | Method and Description |
|---|---|
Batch |
ProcessInstanceMigrationBatchCmd.execute(CommandContext commandContext) |
| Modifier and Type | Method and Description |
|---|---|
List<Batch> |
GetAllBatchesCmd.execute(CommandContext commandContext) |
List<Batch> |
FindBatchesBySearchKeyCmd.execute(CommandContext commandContext) |
| Modifier and Type | Method and Description |
|---|---|
protected ProcessInstanceBatchMigrationResult |
GetProcessInstanceMigrationBatchResultCmd.convertFromBatch(Batch batch,
com.fasterxml.jackson.databind.ObjectMapper objectMapper) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
ProcessInstanceMigrationStatusJobHandler.updateBatchStatus(Batch batch,
String status,
BatchService batchService) |
| Modifier and Type | Method and Description |
|---|---|
Batch |
ProcessInstanceMigrationBuilderImpl.batchMigrateProcessInstances(String processDefinitionId) |
Batch |
ProcessInstanceMigrationBuilderImpl.batchMigrateProcessInstances(String processDefinitionKey,
int processDefinitionVersion,
String processDefinitionTenantId) |
Batch |
ProcessInstanceMigrationManagerImpl.batchMigrateProcessInstancesOfProcessDefinition(String procDefKey,
int procDefVer,
String procDefTenantId,
ProcessInstanceMigrationDocument document,
CommandContext commandContext) |
Batch |
ProcessInstanceMigrationManagerImpl.batchMigrateProcessInstancesOfProcessDefinition(String sourceProcDefId,
ProcessInstanceMigrationDocument document,
CommandContext commandContext) |
| Modifier and Type | Method and Description |
|---|---|
Batch |
ProcessInstanceMigrationBuilder.batchMigrateProcessInstances(String processDefinitionId)
Starts the process instance migration for all process instances of a given process definition identified by the process definition id.
|
Batch |
ProcessInstanceMigrationBuilder.batchMigrateProcessInstances(String processDefinitionKey,
int processDefinitionVersion,
String processDefinitionTenantId)
Asynchronously starts the process instance migration for each process instances of a given process definition identified by the process definition key and version (optional tenantId).
|
Batch |
ProcessInstanceMigrationManager.batchMigrateProcessInstancesOfProcessDefinition(String procDefKey,
int procDefVer,
String procDefTenantId,
ProcessInstanceMigrationDocument document,
CommandContext commandContext) |
Batch |
ProcessInstanceMigrationManager.batchMigrateProcessInstancesOfProcessDefinition(String processDefinitionId,
ProcessInstanceMigrationDocument document,
CommandContext commandContext) |
| Modifier and Type | Method and Description |
|---|---|
void |
BpmnRestApiInterceptor.accessBatchInfoById(Batch batch) |
void |
BpmnRestApiInterceptor.accessBatchPartInfoOfBatch(Batch batch) |
BatchResponse |
RestResponseFactory.createBatchResponse(Batch batch) |
BatchResponse |
RestResponseFactory.createBatchResponse(Batch batch,
RestUrlBuilder urlBuilder) |
void |
BpmnRestApiInterceptor.deleteBatch(Batch batch) |
| Modifier and Type | Method and Description |
|---|---|
List<BatchResponse> |
RestResponseFactory.createBatchResponse(List<Batch> batches) |
| Modifier and Type | Method and Description |
|---|---|
protected Batch |
BatchBaseResource.getBatchById(String batchId) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
BatchBaseResource.validateBatch(Batch batch,
String batchId) |
Copyright © 2023 Flowable. All rights reserved.