org.flowable.engine.impl.migration

Class ProcessInstanceMigrationBuilderImpl

java.lang.Object

org.flowable.engine.impl.migration.ProcessInstanceMigrationBuilderImpl

All Implemented Interfaces:

ProcessInstanceMigrationBuilder

public class ProcessInstanceMigrationBuilderImpl
extends Object
implements ProcessInstanceMigrationBuilder

Author:

Dennis Federico

Field Summary

Fields

Modifier and Type	Field and Description
protected ProcessInstanceMigrationDocumentBuilderImpl	migrationDocumentBuilder
protected RuntimeService	runtimeService

Constructor Summary

Constructors

Constructor and Description
ProcessInstanceMigrationBuilderImpl(RuntimeService runtimeService)

Method Summary

Modifier and Type	Method and Description
ProcessInstanceMigrationBuilder	addActivityMigrationMapping(ActivityMigrationMapping mapping) Adds an activity mapping to the process instance migration plan.
ProcessInstanceMigrationBuilder	fromProcessInstanceMigrationDocument(ProcessInstanceMigrationDocument document) Creates a ProcessInstanceMigrationBuilder using the values of a ProcessInstanceMigrationDocument
ProcessInstanceMigrationDocument	getProcessInstanceMigrationDocument() Builds a ProcessInstanceMigrationDocument
protected RuntimeService	getRuntimeService()
void	migrate(String processInstanceId) Starts the process instance migration for a process identified with the submitted processInstanceId
void	migrateProcessInstances(String processDefinitionId) Starts the process instance migration for all process instances of a given process definition identified by the process definition id.
void	migrateProcessInstances(String processDefinitionKey, int processDefinitionVersion, String processDefinitionTenantId) Starts the process instance migration for all process instances of a given process definition identified by the process definition key and version (optional tenantId).
ProcessInstanceMigrationBuilder	migrateToProcessDefinition(String processDefinitionId) Specifies the process definition to migrate to, using the process definition id
ProcessInstanceMigrationBuilder	migrateToProcessDefinition(String processDefinitionKey, int processDefinitionVersion) Specifies the process definition to migrate to, identified by its key and version
ProcessInstanceMigrationBuilder	migrateToProcessDefinition(String processDefinitionKey, int processDefinitionVersion, String processDefinitionTenantId) Specifies the process definition to migrate to, identified by its key and version and tenantId
ProcessInstanceMigrationValidationResult	validateMigration(String processInstanceId) Validates this process instance migration instructions for a given process instance identified by its processInstanceId
ProcessInstanceMigrationValidationResult	validateMigrationOfProcessInstances(String processDefinitionId) Validates this process instance migration instruction for each process instance of a given process definition identified by the process definition id.
ProcessInstanceMigrationValidationResult	validateMigrationOfProcessInstances(String processDefinitionKey, int processDefinitionVersion, String processDefinitionTenantId) Validates this process instance migration instruction for each process instance of a given process definition identified by the process definition key and version (optional tenantId).
ProcessInstanceMigrationBuilder	withMigrateToProcessDefinitionTenantId(String processDefinitionTenantId) Specifies the tenantId of the process definition to migrate to
ProcessInstanceMigrationBuilder	withProcessInstanceVariable(String variableName, Object variableValue) Specifies a process instance variable that will also be available during the process migration (ie.
ProcessInstanceMigrationBuilder	withProcessInstanceVariables(Map<String,Object> variables) Specified process instances variables that will also be available during process migration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

runtimeService

protected RuntimeService runtimeService

migrationDocumentBuilder

protected ProcessInstanceMigrationDocumentBuilderImpl migrationDocumentBuilder

Constructor Detail

ProcessInstanceMigrationBuilderImpl

public ProcessInstanceMigrationBuilderImpl(RuntimeService runtimeService)

Method Detail

fromProcessInstanceMigrationDocument

public ProcessInstanceMigrationBuilder fromProcessInstanceMigrationDocument(ProcessInstanceMigrationDocument document)

Description copied from interface: ProcessInstanceMigrationBuilder

Creates a ProcessInstanceMigrationBuilder using the values of a ProcessInstanceMigrationDocument

Specified by:

fromProcessInstanceMigrationDocument in interface ProcessInstanceMigrationBuilder

Returns:

See Also:

ProcessInstanceMigrationDocument

migrateToProcessDefinition

public ProcessInstanceMigrationBuilder migrateToProcessDefinition(String processDefinitionId)

Description copied from interface: ProcessInstanceMigrationBuilder

Specifies the process definition to migrate to, using the process definition id

Specified by:

migrateToProcessDefinition in interface ProcessInstanceMigrationBuilder

Returns:

See Also:

ProcessDefinition

migrateToProcessDefinition

public ProcessInstanceMigrationBuilder migrateToProcessDefinition(String processDefinitionKey,
                                                                  int processDefinitionVersion)

Description copied from interface: ProcessInstanceMigrationBuilder

Specifies the process definition to migrate to, identified by its key and version

Specified by:

migrateToProcessDefinition in interface ProcessInstanceMigrationBuilder

Returns:

See Also:

ProcessDefinition

migrateToProcessDefinition

public ProcessInstanceMigrationBuilder migrateToProcessDefinition(String processDefinitionKey,
                                                                  int processDefinitionVersion,
                                                                  String processDefinitionTenantId)

Description copied from interface: ProcessInstanceMigrationBuilder

Specifies the process definition to migrate to, identified by its key and version and tenantId

Specified by:

migrateToProcessDefinition in interface ProcessInstanceMigrationBuilder

Returns:

See Also:

ProcessDefinition

withMigrateToProcessDefinitionTenantId

public ProcessInstanceMigrationBuilder withMigrateToProcessDefinitionTenantId(String processDefinitionTenantId)

Description copied from interface: ProcessInstanceMigrationBuilder

Specifies the tenantId of the process definition to migrate to

Specified by:

withMigrateToProcessDefinitionTenantId in interface ProcessInstanceMigrationBuilder

Returns:

addActivityMigrationMapping

public ProcessInstanceMigrationBuilder addActivityMigrationMapping(ActivityMigrationMapping mapping)

Description copied from interface: ProcessInstanceMigrationBuilder

Adds an activity mapping to the process instance migration plan. Addition order is relevant and "auto-mapping" has priority. There can only be one mapping for a given "from" activity.

Specified by:

addActivityMigrationMapping in interface ProcessInstanceMigrationBuilder

Returns:

See Also:

ActivityMigrationMapping

withProcessInstanceVariable

public ProcessInstanceMigrationBuilder withProcessInstanceVariable(String variableName,
                                                                   Object variableValue)

Description copied from interface: ProcessInstanceMigrationBuilder

Specifies a process instance variable that will also be available during the process migration (ie. to resolve callActivity calledElement expressions of the new process definition - if any)

Specified by:

withProcessInstanceVariable in interface ProcessInstanceMigrationBuilder

Returns:

withProcessInstanceVariables

public ProcessInstanceMigrationBuilder withProcessInstanceVariables(Map<String,Object> variables)

Description copied from interface: ProcessInstanceMigrationBuilder

Specified process instances variables that will also be available during process migration

Specified by:

withProcessInstanceVariables in interface ProcessInstanceMigrationBuilder

Returns:

getProcessInstanceMigrationDocument

public ProcessInstanceMigrationDocument getProcessInstanceMigrationDocument()

Description copied from interface: ProcessInstanceMigrationBuilder

Builds a ProcessInstanceMigrationDocument

Specified by:

getProcessInstanceMigrationDocument in interface ProcessInstanceMigrationBuilder

Returns:

See Also:

ProcessInstanceMigrationDocument

migrate

public void migrate(String processInstanceId)

Description copied from interface: ProcessInstanceMigrationBuilder

Starts the process instance migration for a process identified with the submitted processInstanceId

Specified by:

migrate in interface ProcessInstanceMigrationBuilder

validateMigration

public ProcessInstanceMigrationValidationResult validateMigration(String processInstanceId)

Description copied from interface: ProcessInstanceMigrationBuilder

Validates this process instance migration instructions for a given process instance identified by its processInstanceId

Specified by:

validateMigration in interface ProcessInstanceMigrationBuilder

Returns:

a ProcessInstanceMigrationValidationResult that contains validation error messages - if any

See Also:

ProcessInstanceMigrationValidationResult

migrateProcessInstances

public void migrateProcessInstances(String processDefinitionId)

Description copied from interface: ProcessInstanceMigrationBuilder

Starts the process instance migration for all process instances of a given process definition identified by the process definition id.

Specified by:

migrateProcessInstances in interface ProcessInstanceMigrationBuilder

validateMigrationOfProcessInstances

public ProcessInstanceMigrationValidationResult validateMigrationOfProcessInstances(String processDefinitionId)

Description copied from interface: ProcessInstanceMigrationBuilder

Validates this process instance migration instruction for each process instance of a given process definition identified by the process definition id.

Specified by:

validateMigrationOfProcessInstances in interface ProcessInstanceMigrationBuilder

Returns:

a ProcessInstanceMigrationValidationResult that contains validation error messages - if any

See Also:

ProcessInstanceMigrationValidationResult

migrateProcessInstances

public void migrateProcessInstances(String processDefinitionKey,
                                    int processDefinitionVersion,
                                    String processDefinitionTenantId)

Description copied from interface: ProcessInstanceMigrationBuilder

Starts the process instance migration for all process instances of a given process definition identified by the process definition key and version (optional tenantId).

Specified by:

migrateProcessInstances in interface ProcessInstanceMigrationBuilder

validateMigrationOfProcessInstances

public ProcessInstanceMigrationValidationResult validateMigrationOfProcessInstances(String processDefinitionKey,
                                                                                    int processDefinitionVersion,
                                                                                    String processDefinitionTenantId)

Description copied from interface: ProcessInstanceMigrationBuilder

Validates this process instance migration instruction for each process instance of a given process definition identified by the process definition key and version (optional tenantId).

Specified by:

validateMigrationOfProcessInstances in interface ProcessInstanceMigrationBuilder

Returns:

a ProcessInstanceMigrationValidationResult that contains validation error messages - if any

See Also:

ProcessInstanceMigrationValidationResult

getRuntimeService

protected RuntimeService getRuntimeService()