# Uses of Interface
org.flowable.batch.api.Batch

Packages that use Batch
Package
Description
org.flowable.batch.api
org.flowable.cmmn.api
org.flowable.cmmn.api.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 `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.
org.flowable.engine.migration

- ## Uses of Batch in org.flowable.batch.api

  Methods in org.flowable.batch.api that return Batch
  Modifier and Type
  Method
  Description
  `Batch`
  BatchService.`completeBatch(String batchId, String status)`
  `Batch`
  BatchBuilder.`create()`
  `Batch`
  BatchService.`getBatch(String id)`
  `Batch`
  BatchService.`updateBatch(Batch batch)`
  Methods in org.flowable.batch.api that return types with arguments of type Batch
  Modifier and Type
  Method
  Description
  `List<Batch>`
  BatchService.`findBatchesByQueryCriteria(BatchQuery batchQuery)`
  `List<Batch>`
  BatchService.`findBatchesBySearchKey(String searchKey)`
  `List<Batch>`
  BatchService.`getAllBatches()`
  Methods in org.flowable.batch.api with parameters of type Batch
  Modifier and Type
  Method
  Description
  `BatchPart`
  BatchService.`createBatchPart(Batch batch, String status, String scopeId, String subScopeId, String scopeType)`
  `void`
  BatchService.`insertBatch(Batch batch)`
  `Batch`
  BatchService.`updateBatch(Batch batch)`

- ## Uses of Batch in org.flowable.cmmn.api

  Methods in org.flowable.cmmn.api that return Batch
  Modifier and Type
  Method
  Description
  `Batch`
  CmmnMigrationService.`batchMigrateCaseInstancesOfCaseDefinition(String caseDefinitionKey, int caseDefinitionVersion, String caseDefinitionTenantId, CaseInstanceMigrationDocument caseInstanceMigrationDocument)`
  `Batch`
  CmmnMigrationService.`batchMigrateCaseInstancesOfCaseDefinition(String caseDefinitionId, CaseInstanceMigrationDocument caseInstanceMigrationDocument)`
  `Batch`
  CmmnMigrationService.`batchMigrateHistoricCaseInstancesOfCaseDefinition(String caseDefinitionKey, int caseDefinitionVersion, String caseDefinitionTenantId, HistoricCaseInstanceMigrationDocument historicCaseInstanceMigrationDocument)`
  `Batch`
  CmmnMigrationService.`batchMigrateHistoricCaseInstancesOfCaseDefinition(String caseDefinitionId, HistoricCaseInstanceMigrationDocument historicCaseInstanceMigrationDocument)`
  Methods in org.flowable.cmmn.api with parameters of type Batch
  Modifier and Type
  Method
  Description
  `BatchPartBuilder`
  CmmnManagementService.`createBatchPartBuilder(Batch batch)`

- ## Uses of Batch in org.flowable.cmmn.api.migration

  Methods in org.flowable.cmmn.api.migration that return Batch
  Modifier and Type
  Method
  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).
  `Batch`
  HistoricCaseInstanceMigrationBuilder.`batchMigrateHistoricCaseInstances(String caseDefinitionId)`
  Starts the case instance migration for all case instances of a given case definition identified by the case definition id.
  `Batch`
  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.engine

  Methods in org.flowable.engine that return Batch
  Modifier and Type
  Method
  Description
  `Batch`
  ProcessMigrationService.`batchMigrateProcessInstancesOfProcessDefinition(String processDefinitionKey, int processDefinitionVersion, String processDefinitionTenantId, ProcessInstanceMigrationDocument processInstanceMigrationDocument)`
  `Batch`
  ProcessMigrationService.`batchMigrateProcessInstancesOfProcessDefinition(String processDefinitionId, ProcessInstanceMigrationDocument processInstanceMigrationDocument)`
  Methods in org.flowable.engine that return types with arguments of type Batch
  Modifier and Type
  Method
  Description
  `List<Batch>`
  ManagementService.`findBatchesBySearchKey(String searchKey)`
  `List<Batch>`
  ManagementService.`getAllBatches()`
  Methods in org.flowable.engine with parameters of type Batch
  Modifier and Type
  Method
  Description
  `BatchPartBuilder`
  ManagementService.`createBatchPartBuilder(Batch batch)`

- ## Uses of Batch in org.flowable.engine.migration

  Methods in org.flowable.engine.migration that return Batch
  Modifier and Type
  Method
  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, org.flowable.common.engine.impl.interceptor.CommandContext commandContext)`
  `Batch`
  ProcessInstanceMigrationManager.`batchMigrateProcessInstancesOfProcessDefinition(String processDefinitionId, ProcessInstanceMigrationDocument document, org.flowable.common.engine.impl.interceptor.CommandContext commandContext)`