Uses of Interface
org.flowable.batch.api.Batch
Packages that use Batch
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 Deployment
s.RuntimeService
: For starting and searching ProcessInstance
s.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.
-
Uses of Batch in org.flowable.batch.api
Methods in org.flowable.batch.api that return BatchModifier and TypeMethodDescriptionBatchService.completeBatch
(String batchId, String status) BatchBuilder.create()
BatchService.updateBatch
(Batch batch) Methods in org.flowable.batch.api that return types with arguments of type BatchModifier and TypeMethodDescriptionBatchService.findBatchesByQueryCriteria
(BatchQuery batchQuery) BatchService.findBatchesBySearchKey
(String searchKey) BatchService.getAllBatches()
Methods in org.flowable.batch.api with parameters of type BatchModifier and TypeMethodDescriptionBatchService.createBatchPart
(Batch batch, String status, String scopeId, String subScopeId, String scopeType) void
BatchService.insertBatch
(Batch batch) BatchService.updateBatch
(Batch batch) -
Uses of Batch in org.flowable.batch.service
Fields in org.flowable.batch.service declared as BatchConstructors in org.flowable.batch.service with parameters of type BatchModifierConstructorDescriptionBatchPartBuilderImpl
(Batch batch, BatchServiceConfiguration batchServiceConfiguration) BatchPartBuilderImpl
(Batch batch, BatchServiceConfiguration batchServiceConfiguration, CommandExecutor commandExecutor) -
Uses of Batch in org.flowable.batch.service.impl
Methods in org.flowable.batch.service.impl that return BatchModifier and TypeMethodDescriptionBatchServiceImpl.completeBatch
(String batchId, String status) BatchBuilderImpl.create()
BatchServiceImpl.createBatch
(BatchBuilder batchBuilder) BatchServiceImpl.updateBatch
(Batch batch) Methods in org.flowable.batch.service.impl that return types with arguments of type BatchModifier and TypeMethodDescriptionBatchQueryImpl.executeList
(CommandContext commandContext) BatchServiceImpl.findBatchesByQueryCriteria
(BatchQuery batchQuery) BatchServiceImpl.findBatchesBySearchKey
(String searchKey) BatchServiceImpl.getAllBatches()
Methods in org.flowable.batch.service.impl with parameters of type BatchModifier and TypeMethodDescriptionBatchServiceImpl.createBatchPart
(Batch batch, String status, String scopeId, String subScopeId, String scopeType) void
BatchServiceImpl.insertBatch
(Batch batch) BatchServiceImpl.updateBatch
(Batch batch) -
Uses of Batch in org.flowable.batch.service.impl.persistence.entity
Subinterfaces of Batch in org.flowable.batch.service.impl.persistence.entityClasses in org.flowable.batch.service.impl.persistence.entity that implement BatchMethods in org.flowable.batch.service.impl.persistence.entity that return BatchModifier and TypeMethodDescriptionBatchEntityManager.completeBatch
(String batchId, String status) BatchEntityManagerImpl.completeBatch
(String batchId, String status) BatchEntityManager.createBatch
(BatchBuilder batchBuilder) Methods in org.flowable.batch.service.impl.persistence.entity that return types with arguments of type BatchModifier and TypeMethodDescriptionBatchEntityManager.findAllBatches()
BatchEntityManagerImpl.findAllBatches()
BatchEntityManager.findBatchesByQueryCriteria
(BatchQueryImpl batchQuery) BatchEntityManagerImpl.findBatchesByQueryCriteria
(BatchQueryImpl batchQuery) BatchEntityManager.findBatchesBySearchKey
(String searchKey) BatchEntityManagerImpl.findBatchesBySearchKey
(String searchKey) -
Uses of Batch in org.flowable.batch.service.impl.persistence.entity.data
Methods in org.flowable.batch.service.impl.persistence.entity.data that return types with arguments of type BatchModifier and TypeMethodDescriptionBatchDataManager.findAllBatches()
BatchDataManager.findBatchesByQueryCriteria
(BatchQueryImpl batchQuery) BatchDataManager.findBatchesBySearchKey
(String searchKey) -
Uses of Batch in org.flowable.batch.service.impl.persistence.entity.data.impl
Methods in org.flowable.batch.service.impl.persistence.entity.data.impl that return types with arguments of type BatchModifier and TypeMethodDescriptionMybatisBatchDataManager.findAllBatches()
MybatisBatchDataManager.findBatchesByQueryCriteria
(BatchQueryImpl batchQuery) MybatisBatchDataManager.findBatchesBySearchKey
(String searchKey) -
Uses of Batch in org.flowable.cmmn.api
Methods in org.flowable.cmmn.api that return BatchModifier and TypeMethodDescriptionCmmnMigrationService.batchMigrateCaseInstancesOfCaseDefinition
(String caseDefinitionKey, int caseDefinitionVersion, String caseDefinitionTenantId, CaseInstanceMigrationDocument caseInstanceMigrationDocument) CmmnMigrationService.batchMigrateCaseInstancesOfCaseDefinition
(String caseDefinitionId, CaseInstanceMigrationDocument caseInstanceMigrationDocument) CmmnMigrationService.batchMigrateHistoricCaseInstancesOfCaseDefinition
(String caseDefinitionKey, int caseDefinitionVersion, String caseDefinitionTenantId, HistoricCaseInstanceMigrationDocument historicCaseInstanceMigrationDocument) CmmnMigrationService.batchMigrateHistoricCaseInstancesOfCaseDefinition
(String caseDefinitionId, HistoricCaseInstanceMigrationDocument historicCaseInstanceMigrationDocument) Methods in org.flowable.cmmn.api with parameters of type Batch -
Uses of Batch in org.flowable.cmmn.api.migration
Methods in org.flowable.cmmn.api.migration that return BatchModifier and TypeMethodDescriptionCaseInstanceMigrationBuilder.batchMigrateCaseInstances
(String caseDefinitionId) Starts the case instance migration for all case instances of a given case definition identified by the case definition id.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).HistoricCaseInstanceMigrationBuilder.batchMigrateHistoricCaseInstances
(String caseDefinitionId) Starts the case instance migration for all case instances of a given case definition identified by the case definition id.HistoricCaseInstanceMigrationBuilder.batchMigrateHistoricCaseInstances
(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). -
Uses of Batch in org.flowable.cmmn.engine.impl
Methods in org.flowable.cmmn.engine.impl with parameters of type Batch -
Uses of Batch in org.flowable.cmmn.engine.impl.cmd
Methods in org.flowable.cmmn.engine.impl.cmd that return BatchModifier and TypeMethodDescriptionCaseInstanceMigrationBatchCmd.execute
(CommandContext commandContext) HistoricCaseInstanceMigrationBatchCmd.execute
(CommandContext commandContext) Methods in org.flowable.cmmn.engine.impl.cmd with parameters of type BatchModifier and TypeMethodDescriptionprotected CaseInstanceBatchMigrationResult
GetCaseInstanceMigrationBatchResultCmd.convertFromBatch
(Batch batch, com.fasterxml.jackson.databind.ObjectMapper objectMapper) -
Uses of Batch in org.flowable.cmmn.engine.impl.delete
Fields in org.flowable.cmmn.engine.impl.delete declared as BatchMethods in org.flowable.cmmn.engine.impl.delete that return BatchMethods in org.flowable.cmmn.engine.impl.delete with parameters of type BatchModifier and TypeMethodDescriptionprotected void
ComputeDeleteHistoricCaseInstanceIdsJobHandler.completeBatch
(Batch batch, String status, CmmnEngineConfiguration engineConfiguration) protected void
ComputeDeleteHistoricCaseInstanceStatusJobHandler.completeBatch
(Batch batch, String status, CmmnEngineConfiguration engineConfiguration) protected void
DeleteHistoricCaseInstanceIdsStatusJobHandler.completeBatch
(Batch batch, String status, CmmnEngineConfiguration engineConfiguration) protected void
DeleteHistoricCaseInstancesSequentialJobHandler.completeBatch
(Batch batch, String status, CmmnEngineConfiguration engineConfiguration) protected void
DeleteHistoricCaseInstanceIdsStatusJobHandler.completeBatchFail
(Batch batch, List<BatchPart> failedParts, CmmnEngineConfiguration engineConfiguration) protected void
DeleteHistoricCaseInstancesUsingBatchesCmd.createBatchPartsForParallelExecution
(CmmnEngineConfiguration engineConfiguration, Batch batch, long numberOfBatchParts) protected void
DeleteHistoricCaseInstancesUsingBatchesCmd.createBatchPartsForSequentialExecution
(CmmnEngineConfiguration engineConfiguration, Batch batch, long numberOfBatchParts) protected BatchPartQuery
ComputeDeleteHistoricCaseInstanceStatusJobHandler.createStatusQuery
(Batch batch, CmmnManagementService managementService) protected BatchPartQuery
DeleteHistoricCaseInstanceIdsStatusJobHandler.createStatusQuery
(Batch batch, CmmnManagementService managementService) protected void
ComputeDeleteHistoricCaseInstanceIdsJobHandler.failBatchPart
(CmmnEngineConfiguration engineConfiguration, BatchService batchService, BatchPart batchPart, Batch batch, String resultJson, boolean sequentialExecution) protected void
DeleteHistoricCaseInstancesSequentialJobHandler.failBatchPart
(CmmnEngineConfiguration engineConfiguration, BatchService batchService, BatchPart batchPart, Batch batch, String resultJson) protected static com.fasterxml.jackson.databind.JsonNode
BatchDeleteCaseConfig.getBatchConfiguration
(Batch batch, CmmnEngineConfiguration engineConfiguration) Constructors in org.flowable.cmmn.engine.impl.delete with parameters of type BatchModifierConstructorDescriptionprotected
BatchDeleteCaseConfig
(Batch batch, BatchPart batchPart, String error, boolean sequentialExecution) -
Uses of Batch in org.flowable.cmmn.engine.impl.job
Methods in org.flowable.cmmn.engine.impl.job with parameters of type BatchModifier and TypeMethodDescriptionprotected void
CaseInstanceMigrationStatusJobHandler.updateBatchStatus
(Batch batch, BatchService batchService) -
Uses of Batch in org.flowable.cmmn.engine.impl.migration
Methods in org.flowable.cmmn.engine.impl.migration that return BatchModifier and TypeMethodDescriptionCaseInstanceMigrationBuilderImpl.batchMigrateCaseInstances
(String caseDefinitionId) CaseInstanceMigrationBuilderImpl.batchMigrateCaseInstances
(String caseDefinitionKey, int caseDefinitionVersion, String caseDefinitionTenantId) CaseInstanceMigrationManager.batchMigrateCaseInstancesOfCaseDefinition
(String caseDefinitionKey, int caseDefinitionVersion, String caseDefinitionTenantId, CaseInstanceMigrationDocument document, CommandContext commandContext) CaseInstanceMigrationManager.batchMigrateCaseInstancesOfCaseDefinition
(String caseDefinitionId, CaseInstanceMigrationDocument document, CommandContext commandContext) CaseInstanceMigrationManagerImpl.batchMigrateCaseInstancesOfCaseDefinition
(String caseDefinitionKey, int caseDefinitionVersion, String caseDefinitionTenantId, CaseInstanceMigrationDocument document, CommandContext commandContext) CaseInstanceMigrationManagerImpl.batchMigrateCaseInstancesOfCaseDefinition
(String caseDefinitionId, CaseInstanceMigrationDocument document, CommandContext commandContext) CmmnMigrationServiceImpl.batchMigrateCaseInstancesOfCaseDefinition
(String caseDefinitionKey, int caseDefinitionVersion, String caseDefinitionTenantId, CaseInstanceMigrationDocument caseInstanceMigrationDocument) CmmnMigrationServiceImpl.batchMigrateCaseInstancesOfCaseDefinition
(String caseDefinitionId, CaseInstanceMigrationDocument caseInstanceMigrationDocument) HistoricCaseInstanceMigrationBuilderImpl.batchMigrateHistoricCaseInstances
(String caseDefinitionId) HistoricCaseInstanceMigrationBuilderImpl.batchMigrateHistoricCaseInstances
(String caseDefinitionKey, int caseDefinitionVersion, String caseDefinitionTenantId) CaseInstanceMigrationManager.batchMigrateHistoricCaseInstancesOfCaseDefinition
(String caseDefinitionKey, int caseDefinitionVersion, String caseDefinitionTenantId, HistoricCaseInstanceMigrationDocument document, CommandContext commandContext) CaseInstanceMigrationManager.batchMigrateHistoricCaseInstancesOfCaseDefinition
(String caseDefinitionId, HistoricCaseInstanceMigrationDocument document, CommandContext commandContext) CaseInstanceMigrationManagerImpl.batchMigrateHistoricCaseInstancesOfCaseDefinition
(String caseDefinitionKey, int caseDefinitionVersion, String caseDefinitionTenantId, HistoricCaseInstanceMigrationDocument document, CommandContext commandContext) CaseInstanceMigrationManagerImpl.batchMigrateHistoricCaseInstancesOfCaseDefinition
(String caseDefinitionId, HistoricCaseInstanceMigrationDocument document, CommandContext commandContext) CmmnMigrationServiceImpl.batchMigrateHistoricCaseInstancesOfCaseDefinition
(String caseDefinitionKey, int caseDefinitionVersion, String caseDefinitionTenantId, HistoricCaseInstanceMigrationDocument historicCaseInstanceMigrationDocument) CmmnMigrationServiceImpl.batchMigrateHistoricCaseInstancesOfCaseDefinition
(String caseDefinitionId, HistoricCaseInstanceMigrationDocument historicCaseInstanceMigrationDocument) -
Uses of Batch in org.flowable.engine
Methods in org.flowable.engine that return BatchModifier and TypeMethodDescriptionProcessMigrationService.batchMigrateProcessInstancesOfProcessDefinition
(String processDefinitionKey, int processDefinitionVersion, String processDefinitionTenantId, ProcessInstanceMigrationDocument processInstanceMigrationDocument) ProcessMigrationService.batchMigrateProcessInstancesOfProcessDefinition
(String processDefinitionId, ProcessInstanceMigrationDocument processInstanceMigrationDocument) Methods in org.flowable.engine that return types with arguments of type BatchModifier and TypeMethodDescriptionManagementService.findBatchesBySearchKey
(String searchKey) ManagementService.getAllBatches()
Methods in org.flowable.engine with parameters of type Batch -
Uses of Batch in org.flowable.engine.impl
Methods in org.flowable.engine.impl that return BatchModifier and TypeMethodDescriptionProcessMigrationServiceImpl.batchMigrateProcessInstancesOfProcessDefinition
(String processDefinitionKey, int processDefinitionVersion, String processDefinitionTenantId, ProcessInstanceMigrationDocument processInstanceMigrationDocument) ProcessMigrationServiceImpl.batchMigrateProcessInstancesOfProcessDefinition
(String processDefinitionId, ProcessInstanceMigrationDocument processInstanceMigrationDocument) Methods in org.flowable.engine.impl that return types with arguments of type BatchModifier and TypeMethodDescriptionManagementServiceImpl.findBatchesBySearchKey
(String searchKey) ManagementServiceImpl.getAllBatches()
Methods in org.flowable.engine.impl with parameters of type Batch -
Uses of Batch in org.flowable.engine.impl.cmd
Methods in org.flowable.engine.impl.cmd that return BatchModifier and TypeMethodDescriptionProcessInstanceMigrationBatchCmd.execute
(CommandContext commandContext) Methods in org.flowable.engine.impl.cmd that return types with arguments of type BatchModifier and TypeMethodDescriptionFindBatchesBySearchKeyCmd.execute
(CommandContext commandContext) GetAllBatchesCmd.execute
(CommandContext commandContext) Methods in org.flowable.engine.impl.cmd with parameters of type BatchModifier and TypeMethodDescriptionprotected ProcessInstanceBatchMigrationResult
GetProcessInstanceMigrationBatchResultCmd.convertFromBatch
(Batch batch, com.fasterxml.jackson.databind.ObjectMapper objectMapper) -
Uses of Batch in org.flowable.engine.impl.delete
Fields in org.flowable.engine.impl.delete declared as BatchMethods in org.flowable.engine.impl.delete that return BatchMethods in org.flowable.engine.impl.delete with parameters of type BatchModifier and TypeMethodDescriptionprotected void
ComputeDeleteHistoricProcessInstanceIdsJobHandler.completeBatch
(Batch batch, String status, ProcessEngineConfigurationImpl engineConfiguration) protected void
ComputeDeleteHistoricProcessInstanceStatusJobHandler.completeBatch
(Batch batch, String status, ProcessEngineConfigurationImpl engineConfiguration) protected void
DeleteHistoricProcessInstanceIdsStatusJobHandler.completeBatch
(Batch batch, String status, ProcessEngineConfigurationImpl engineConfiguration) protected void
DeleteHistoricProcessInstancesSequentialJobHandler.completeBatch
(Batch batch, String status, ProcessEngineConfigurationImpl engineConfiguration) protected void
DeleteHistoricProcessInstanceIdsStatusJobHandler.completeBatchFail
(Batch batch, List<BatchPart> failedParts, ProcessEngineConfigurationImpl engineConfiguration) protected void
DeleteHistoricProcessInstancesUsingBatchesCmd.createBatchPartsForParallelExecution
(ProcessEngineConfigurationImpl engineConfiguration, Batch batch, long numberOfBatchParts) protected void
DeleteHistoricProcessInstancesUsingBatchesCmd.createBatchPartsForSequentialExecution
(ProcessEngineConfigurationImpl engineConfiguration, Batch batch, long numberOfBatchParts) protected BatchPartQuery
ComputeDeleteHistoricProcessInstanceStatusJobHandler.createStatusQuery
(Batch batch, ManagementService managementService) protected BatchPartQuery
DeleteHistoricProcessInstanceIdsStatusJobHandler.createStatusQuery
(Batch batch, ManagementService managementService) protected void
ComputeDeleteHistoricProcessInstanceIdsJobHandler.failBatchPart
(ProcessEngineConfigurationImpl engineConfiguration, BatchService batchService, BatchPart batchPart, Batch batch, String resultJson, boolean sequentialExecution) protected void
DeleteHistoricProcessInstancesSequentialJobHandler.failBatchPart
(ProcessEngineConfigurationImpl engineConfiguration, BatchService batchService, BatchPart batchPart, Batch batch, String resultJson) protected static com.fasterxml.jackson.databind.JsonNode
BatchDeleteProcessConfig.getBatchConfiguration
(Batch batch, ProcessEngineConfigurationImpl engineConfiguration) Constructors in org.flowable.engine.impl.delete with parameters of type BatchModifierConstructorDescriptionprotected
BatchDeleteProcessConfig
(Batch batch, BatchPart batchPart, String error, boolean sequentialExecution) -
Uses of Batch in org.flowable.engine.impl.jobexecutor
Methods in org.flowable.engine.impl.jobexecutor with parameters of type BatchModifier and TypeMethodDescriptionprotected void
ProcessInstanceMigrationStatusJobHandler.updateBatchStatus
(Batch batch, String status, BatchService batchService) -
Uses of Batch in org.flowable.engine.impl.migration
Methods in org.flowable.engine.impl.migration that return BatchModifier and TypeMethodDescriptionProcessInstanceMigrationBuilderImpl.batchMigrateProcessInstances
(String processDefinitionId) ProcessInstanceMigrationBuilderImpl.batchMigrateProcessInstances
(String processDefinitionKey, int processDefinitionVersion, String processDefinitionTenantId) ProcessInstanceMigrationManagerImpl.batchMigrateProcessInstancesOfProcessDefinition
(String procDefKey, int procDefVer, String procDefTenantId, ProcessInstanceMigrationDocument document, CommandContext commandContext) ProcessInstanceMigrationManagerImpl.batchMigrateProcessInstancesOfProcessDefinition
(String sourceProcDefId, ProcessInstanceMigrationDocument document, CommandContext commandContext) -
Uses of Batch in org.flowable.engine.migration
Methods in org.flowable.engine.migration that return BatchModifier and TypeMethodDescriptionProcessInstanceMigrationBuilder.batchMigrateProcessInstances
(String processDefinitionId) Starts the process instance migration for all process instances of a given process definition identified by the process definition id.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).ProcessInstanceMigrationManager.batchMigrateProcessInstancesOfProcessDefinition
(String procDefKey, int procDefVer, String procDefTenantId, ProcessInstanceMigrationDocument document, CommandContext commandContext) ProcessInstanceMigrationManager.batchMigrateProcessInstancesOfProcessDefinition
(String processDefinitionId, ProcessInstanceMigrationDocument document, CommandContext commandContext) -
Uses of Batch in org.flowable.rest.service.api
Methods in org.flowable.rest.service.api with parameters of type BatchModifier and TypeMethodDescriptionvoid
BpmnRestApiInterceptor.accessBatchInfoById
(Batch batch) void
BpmnRestApiInterceptor.accessBatchPartInfoOfBatch
(Batch batch) RestResponseFactory.createBatchResponse
(Batch batch) RestResponseFactory.createBatchResponse
(Batch batch, RestUrlBuilder urlBuilder) void
BpmnRestApiInterceptor.deleteBatch
(Batch batch) Method parameters in org.flowable.rest.service.api with type arguments of type Batch -
Uses of Batch in org.flowable.rest.service.api.management
Methods in org.flowable.rest.service.api.management that return BatchMethods in org.flowable.rest.service.api.management with parameters of type BatchModifier and TypeMethodDescriptionprotected void
BatchBaseResource.validateBatch
(Batch batch, String batchId)