org.camunda.bpm.engine.migration
Interface MigrationPlanExecutionBuilder

All Known Implementing Classes:

MigrationPlanExecutionBuilderImpl

public interface MigrationPlanExecutionBuilder

Builder to execute a migration.

Method Summary

void	execute() Execute the migration synchronously.
Batch	executeAsync() Execute the migration asynchronously as batch.
MigrationPlanExecutionBuilder	processInstanceIds(List<String> processInstanceIds)
MigrationPlanExecutionBuilder	processInstanceQuery(ProcessInstanceQuery processInstanceQuery)

Method Detail

processInstanceIds

MigrationPlanExecutionBuilder processInstanceIds(List<String> processInstanceIds)

Parameters:

processInstanceIds - the process instance ids to migrate.

processInstanceQuery

MigrationPlanExecutionBuilder processInstanceQuery(ProcessInstanceQuery processInstanceQuery)

Parameters:

processInstanceQuery - a query which selects the process instances to migrate. Query results are restricted to process instances for which the user has Permissions.READ permission.

execute

void execute()

Execute the migration synchronously.

Throws:

MigratingProcessInstanceValidationException - if the migration plan contains instructions that are not applicable to any of the process instances

AuthorizationException - if the user has no Permissions.MIGRATE_INSTANCE permission on Resources.PROCESS_DEFINITION for both, source and target process definition.

executeAsync

Batch executeAsync()

Execute the migration asynchronously as batch. The returned batch can be used to track the progress of the migration.

Returns:

the batch which executes the migration asynchronously.

Throws:

AuthorizationException - if the user has no Permissions.MIGRATE_INSTANCE permission on Resources.PROCESS_DEFINITION for both, source and target process definition.