Package org.flowable.cmmn.engine.impl.migration

Class CaseInstanceMigrationBuilderImpl

java.lang.Object

org.flowable.cmmn.engine.impl.migration.CaseInstanceMigrationBuilderImpl

All Implemented Interfaces:

CaseInstanceMigrationBuilder

public class CaseInstanceMigrationBuilderImpl
extends Object
implements CaseInstanceMigrationBuilder

Author:

Valentin Zickner

Field Summary

Fields

Modifier and Type	Field	Description
protected CaseInstanceMigrationDocumentBuilderImpl	caseInstanceMigrationDocumentDocumentBuilder
protected CmmnMigrationService	cmmnMigrationService

Constructor Summary

Constructors

Constructor	Description
CaseInstanceMigrationBuilderImpl(CmmnMigrationService cmmnMigrationService)

Method Summary

Modifier and Type	Method	Description
CaseInstanceMigrationBuilder	addActivatePlanItemDefinitionMapping(ActivatePlanItemDefinitionMapping mapping)	Adds an activate plan item definition mapping to the case instance migration plan.
CaseInstanceMigrationBuilder	addChangePlanItemDefinitionWithNewTargetIdsMapping(ChangePlanItemDefinitionWithNewTargetIdsMapping mapping)	Adds a mapping for a plan item definition id to a new plan item id and definition id to change the plan item id.
CaseInstanceMigrationBuilder	addChangePlanItemIdMapping(ChangePlanItemIdMapping mapping)	Adds a mapping for a plan item id to new plan item id.
CaseInstanceMigrationBuilder	addChangePlanItemIdWithDefinitionIdMapping(ChangePlanItemIdWithDefinitionIdMapping mapping)	Adds a mapping for a plan item definition id to a new plan item definition id to change the plan item id.
CaseInstanceMigrationBuilder	addMoveToAvailablePlanItemDefinitionMapping(MoveToAvailablePlanItemDefinitionMapping mapping)	Adds a move to available plan item definition mapping to the case instance migration plan.
CaseInstanceMigrationBuilder	addTerminatePlanItemDefinitionMapping(TerminatePlanItemDefinitionMapping mapping)	Adds a terminate plan item definition mapping to the case instance migration plan.
CaseInstanceMigrationBuilder	addWaitingForRepetitionPlanItemDefinitionMapping(WaitingForRepetitionPlanItemDefinitionMapping mapping)	Adds a waiting for repetition plan item definition mapping to the case instance migration plan.
Batch	batchMigrateCaseInstances(String caseDefinitionId)	Starts the case instance migration for all case instances of a given case definition identified by the case definition id.
Batch	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).
CaseInstanceMigrationBuilder	fromCaseInstanceMigrationDocument(CaseInstanceMigrationDocument caseInstanceMigrationDocument)	Creates a CaseInstanceMigrationBuilder using the values of a CaseInstanceMigrationDocument
CaseInstanceMigrationDocument	getCaseInstanceMigrationDocument()	Builds a CaseInstanceMigrationDocument
protected CmmnMigrationService	getCmmnMigrationService()
void	migrate(String caseInstanceId)	Starts the case instance migration for a case identified with the submitted caseInstanceId
void	migrateCaseInstances(String caseDefinitionId)	Asynchronously starts the case instance migration for each case instances of a given case definition identified by the case definition id.
void	migrateCaseInstances(String caseDefinitionKey, int caseDefinitionVersion, String caseDefinitionTenantId)	Starts the case instance migration for all case instances of a given case definition identified by the case definition key and version (optional tenantId).
CaseInstanceMigrationBuilder	migrateToCaseDefinition(String caseDefinitionId)	Specifies the case definition to migrate to, using the case definition id
CaseInstanceMigrationBuilder	migrateToCaseDefinition(String caseDefinitionKey, int caseDefinitionVersion)	Specifies the case definition to migrate to, identified by its key and version
CaseInstanceMigrationBuilder	migrateToCaseDefinition(String caseDefinitionKey, int caseDefinitionVersion, String caseDefinitionTenantId)	Specifies the case definition to migrate to, identified by its key and version and tenantId
CaseInstanceMigrationBuilder	removeWaitingForRepetitionPlanItemDefinitionMapping(RemoveWaitingForRepetitionPlanItemDefinitionMapping mapping)	Removes a waiting for repetition plan item definition mapping to the case instance migration plan.
CaseInstanceMigrationValidationResult	validateMigration(String caseInstanceId)	Validates this case instance migration instructions for a given case instance identified by its caseInstanceId
CaseInstanceMigrationValidationResult	validateMigrationOfCaseInstances(String caseDefinitionId)	Validates this case instance migration instruction for each case instance of a given case definition identified by the case definition id.
CaseInstanceMigrationValidationResult	validateMigrationOfCaseInstances(String caseDefinitionKey, int caseDefinitionVersion, String caseDefinitionTenantId)	Validates this case instance migration instruction for each case instance of a given case definition identified by the case definition key and version (optional tenantId).
CaseInstanceMigrationBuilder	withCaseInstanceVariable(String variableName, Object variableValue)	Specifies a case instance variable that will also be available during the case migration
CaseInstanceMigrationBuilder	withCaseInstanceVariables(Map<String,Object> variables)	Specified case instances variables that will also be available during case migration
CaseInstanceMigrationBuilder	withMigrateToCaseDefinitionTenantId(String caseDefinitionTenantId)	Specifies the tenantId of the case definition to migrate to
CaseInstanceMigrationBuilder	withPostUpgradeExpression(String postUpgradeExpression)	Specifies an expression which is executed after the migration is finished.
CaseInstanceMigrationBuilder	withPreUpgradeExpression(String preUpgradeExpression)	Specifies an expression which is executed before the migration starts.

Methods inherited from class java.lang.Object

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

Field Details

cmmnMigrationService

protected CmmnMigrationService cmmnMigrationService

caseInstanceMigrationDocumentDocumentBuilder

protected CaseInstanceMigrationDocumentBuilderImpl caseInstanceMigrationDocumentDocumentBuilder

Constructor Details

CaseInstanceMigrationBuilderImpl

public CaseInstanceMigrationBuilderImpl(CmmnMigrationService cmmnMigrationService)

Method Details

fromCaseInstanceMigrationDocument

public CaseInstanceMigrationBuilder fromCaseInstanceMigrationDocument(CaseInstanceMigrationDocument caseInstanceMigrationDocument)

Description copied from interface: CaseInstanceMigrationBuilder

Creates a CaseInstanceMigrationBuilder using the values of a CaseInstanceMigrationDocument

Specified by:

fromCaseInstanceMigrationDocument in interface CaseInstanceMigrationBuilder

Parameters:

caseInstanceMigrationDocument - Migration document with pre-filled case information

Returns:

Returns the builder

See Also:

• CaseInstanceMigrationDocument

migrateToCaseDefinition

public CaseInstanceMigrationBuilder migrateToCaseDefinition(String caseDefinitionId)

Description copied from interface: CaseInstanceMigrationBuilder

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

Specified by:

migrateToCaseDefinition in interface CaseInstanceMigrationBuilder

Parameters:

caseDefinitionId - ID of the case definition to migrate to

Returns:

Returns the builder

See Also:

• CaseDefinition

migrateToCaseDefinition

public CaseInstanceMigrationBuilder migrateToCaseDefinition(String caseDefinitionKey,
 int caseDefinitionVersion)

Description copied from interface: CaseInstanceMigrationBuilder

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

Specified by:

migrateToCaseDefinition in interface CaseInstanceMigrationBuilder

Parameters:

caseDefinitionKey - Key of the case definition to migrate to

caseDefinitionVersion - Version of the case to migrate to

Returns:

Returns the builder

See Also:

• CaseDefinition

migrateToCaseDefinition

public CaseInstanceMigrationBuilder migrateToCaseDefinition(String caseDefinitionKey,
 int caseDefinitionVersion,
 String caseDefinitionTenantId)

Description copied from interface: CaseInstanceMigrationBuilder

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

Specified by:

migrateToCaseDefinition in interface CaseInstanceMigrationBuilder

Parameters:

caseDefinitionKey - Key of the case definition to migrate to

caseDefinitionVersion - Version of the case to migrate to

caseDefinitionTenantId - Tenant id of the case definition, must be part of the same tenant

Returns:

Returns the builder

See Also:

• CaseDefinition

withMigrateToCaseDefinitionTenantId

public CaseInstanceMigrationBuilder withMigrateToCaseDefinitionTenantId(String caseDefinitionTenantId)

Description copied from interface: CaseInstanceMigrationBuilder

Specifies the tenantId of the case definition to migrate to

Specified by:

withMigrateToCaseDefinitionTenantId in interface CaseInstanceMigrationBuilder

Parameters:

caseDefinitionTenantId - Tenant id of the case definition, must be part of the same tenant

Returns:

Returns the builder

addActivatePlanItemDefinitionMapping

public CaseInstanceMigrationBuilder addActivatePlanItemDefinitionMapping(ActivatePlanItemDefinitionMapping mapping)

Description copied from interface: CaseInstanceMigrationBuilder

Adds an activate plan item definition mapping to the case instance migration plan.

Specified by:

addActivatePlanItemDefinitionMapping in interface CaseInstanceMigrationBuilder

Parameters:

mapping - Mapping for a specific plan item definition

Returns:

Returns the builder

See Also:

• ActivatePlanItemDefinitionMapping

addTerminatePlanItemDefinitionMapping

public CaseInstanceMigrationBuilder addTerminatePlanItemDefinitionMapping(TerminatePlanItemDefinitionMapping mapping)

Description copied from interface: CaseInstanceMigrationBuilder

Adds a terminate plan item definition mapping to the case instance migration plan.

Specified by:

addTerminatePlanItemDefinitionMapping in interface CaseInstanceMigrationBuilder

Parameters:

mapping - Mapping for a specific plan item definition

Returns:

Returns the builder

See Also:

• TerminatePlanItemDefinitionMapping

addMoveToAvailablePlanItemDefinitionMapping

public CaseInstanceMigrationBuilder addMoveToAvailablePlanItemDefinitionMapping(MoveToAvailablePlanItemDefinitionMapping mapping)

Description copied from interface: CaseInstanceMigrationBuilder

Adds a move to available plan item definition mapping to the case instance migration plan.

Specified by:

addMoveToAvailablePlanItemDefinitionMapping in interface CaseInstanceMigrationBuilder

Parameters:

mapping - Mapping for a specific plan item definition

Returns:

Returns the builder

See Also:

• MoveToAvailablePlanItemDefinitionMapping

addWaitingForRepetitionPlanItemDefinitionMapping

public CaseInstanceMigrationBuilder addWaitingForRepetitionPlanItemDefinitionMapping(WaitingForRepetitionPlanItemDefinitionMapping mapping)

Description copied from interface: CaseInstanceMigrationBuilder

Adds a waiting for repetition plan item definition mapping to the case instance migration plan.

Specified by:

addWaitingForRepetitionPlanItemDefinitionMapping in interface CaseInstanceMigrationBuilder

Parameters:

mapping - Mapping for a specific plan item definition

Returns:

Returns the builder

See Also:

• WaitingForRepetitionPlanItemDefinitionMapping

removeWaitingForRepetitionPlanItemDefinitionMapping

public CaseInstanceMigrationBuilder removeWaitingForRepetitionPlanItemDefinitionMapping(RemoveWaitingForRepetitionPlanItemDefinitionMapping mapping)

Description copied from interface: CaseInstanceMigrationBuilder

Removes a waiting for repetition plan item definition mapping to the case instance migration plan.

Specified by:

removeWaitingForRepetitionPlanItemDefinitionMapping in interface CaseInstanceMigrationBuilder

Parameters:

mapping - Mapping for a specific plan item definition

Returns:

Returns the builder

See Also:

• WaitingForRepetitionPlanItemDefinitionMapping

addChangePlanItemIdMapping

public CaseInstanceMigrationBuilder addChangePlanItemIdMapping(ChangePlanItemIdMapping mapping)

Description copied from interface: CaseInstanceMigrationBuilder

Adds a mapping for a plan item id to new plan item id. This should not be needed in general, but there are cases where the plan item can have a new plan item id between different versions, and that's why this option is added.

Specified by:

addChangePlanItemIdMapping in interface CaseInstanceMigrationBuilder

Parameters:

mapping - Mapping from an existing plan item id to a new plan item id

Returns:

Returns the builder

See Also:

• ChangePlanItemIdMapping

addChangePlanItemIdWithDefinitionIdMapping

public CaseInstanceMigrationBuilder addChangePlanItemIdWithDefinitionIdMapping(ChangePlanItemIdWithDefinitionIdMapping mapping)

Description copied from interface: CaseInstanceMigrationBuilder

Adds a mapping for a plan item definition id to a new plan item definition id to change the plan item id. This should not be needed in general, but there are cases where the plan item can have a new plan item id between different versions, and that's why this option is added.

Specified by:

addChangePlanItemIdWithDefinitionIdMapping in interface CaseInstanceMigrationBuilder

Parameters:

mapping - Mapping from an existing plan item definition id to a new plan item definition id to change the plan item id

Returns:

Returns the builder

See Also:

• ChangePlanItemIdWithDefinitionIdMapping

addChangePlanItemDefinitionWithNewTargetIdsMapping

public CaseInstanceMigrationBuilder addChangePlanItemDefinitionWithNewTargetIdsMapping(ChangePlanItemDefinitionWithNewTargetIdsMapping mapping)

Description copied from interface: CaseInstanceMigrationBuilder

Adds a mapping for a plan item definition id to a new plan item id and definition id to change the plan item id. This should not be needed in general, but there are cases where the plan item can have a new plan item id between different versions, and that's why this option is added.

Specified by:

addChangePlanItemDefinitionWithNewTargetIdsMapping in interface CaseInstanceMigrationBuilder

Parameters:

mapping - Mapping from an existing plan item definition id to a new plan item id and definition id to change the plan item id

Returns:

Returns the builder

See Also:

• ChangePlanItemDefinitionWithNewTargetIdsMapping

withPreUpgradeExpression

public CaseInstanceMigrationBuilder withPreUpgradeExpression(String preUpgradeExpression)

Description copied from interface: CaseInstanceMigrationBuilder

Specifies an expression which is executed before the migration starts.

Specified by:

withPreUpgradeExpression in interface CaseInstanceMigrationBuilder

Parameters:

preUpgradeExpression - the expression e.g. ${mySpringBean.doSomething()}

Returns:

Returns the builder

withPostUpgradeExpression

public CaseInstanceMigrationBuilder withPostUpgradeExpression(String postUpgradeExpression)

Description copied from interface: CaseInstanceMigrationBuilder

Specifies an expression which is executed after the migration is finished.

Specified by:

withPostUpgradeExpression in interface CaseInstanceMigrationBuilder

Parameters:

postUpgradeExpression - the expression e.g. ${mySpringBean.doSomething()}

Returns:

Returns the builder

withCaseInstanceVariable

public CaseInstanceMigrationBuilder withCaseInstanceVariable(String variableName,
 Object variableValue)

Description copied from interface: CaseInstanceMigrationBuilder

Specifies a case instance variable that will also be available during the case migration

Specified by:

withCaseInstanceVariable in interface CaseInstanceMigrationBuilder

Parameters:

variableName - Name of the variable

variableValue - Value of the variable

Returns:

Returns the builder

withCaseInstanceVariables

public CaseInstanceMigrationBuilder withCaseInstanceVariables(Map<String,Object> variables)

Description copied from interface: CaseInstanceMigrationBuilder

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

Specified by:

withCaseInstanceVariables in interface CaseInstanceMigrationBuilder

Returns:

Returns the builder

getCaseInstanceMigrationDocument

public CaseInstanceMigrationDocument getCaseInstanceMigrationDocument()

Description copied from interface: CaseInstanceMigrationBuilder

Builds a CaseInstanceMigrationDocument

Specified by:

getCaseInstanceMigrationDocument in interface CaseInstanceMigrationBuilder

Returns:

Returns the builder

See Also:

• CaseInstanceMigrationDocument

migrate

public void migrate(String caseInstanceId)

Description copied from interface: CaseInstanceMigrationBuilder

Starts the case instance migration for a case identified with the submitted caseInstanceId

Specified by:

migrate in interface CaseInstanceMigrationBuilder

validateMigration

public CaseInstanceMigrationValidationResult validateMigration(String caseInstanceId)

Description copied from interface: CaseInstanceMigrationBuilder

Validates this case instance migration instructions for a given case instance identified by its caseInstanceId

Specified by:

validateMigration in interface CaseInstanceMigrationBuilder

Returns:

a CaseInstanceMigrationValidationResult that contains validation error messages - if any

migrateCaseInstances

public void migrateCaseInstances(String caseDefinitionId)

Description copied from interface: CaseInstanceMigrationBuilder

Asynchronously starts the case instance migration for each case instances of a given case definition identified by the case definition id.

Specified by:

migrateCaseInstances in interface CaseInstanceMigrationBuilder

batchMigrateCaseInstances

public Batch batchMigrateCaseInstances(String caseDefinitionId)

Description copied from interface: CaseInstanceMigrationBuilder

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

Specified by:

batchMigrateCaseInstances in interface CaseInstanceMigrationBuilder

validateMigrationOfCaseInstances

public CaseInstanceMigrationValidationResult validateMigrationOfCaseInstances(String caseDefinitionId)

Description copied from interface: CaseInstanceMigrationBuilder

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

Specified by:

validateMigrationOfCaseInstances in interface CaseInstanceMigrationBuilder

Returns:

a CaseInstanceMigrationValidationResult that contains validation error messages - if any

See Also:

• CaseInstanceMigrationValidationResult

migrateCaseInstances

public void migrateCaseInstances(String caseDefinitionKey,
 int caseDefinitionVersion,
 String caseDefinitionTenantId)

Description copied from interface: CaseInstanceMigrationBuilder

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

Specified by:

migrateCaseInstances in interface CaseInstanceMigrationBuilder

batchMigrateCaseInstances

public Batch batchMigrateCaseInstances(String caseDefinitionKey,
 int caseDefinitionVersion,
 String caseDefinitionTenantId)

Description copied from interface: CaseInstanceMigrationBuilder

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).

Specified by:

batchMigrateCaseInstances in interface CaseInstanceMigrationBuilder

Returns:

an id of the created batch entity

validateMigrationOfCaseInstances

public CaseInstanceMigrationValidationResult validateMigrationOfCaseInstances(String caseDefinitionKey,
 int caseDefinitionVersion,
 String caseDefinitionTenantId)

Description copied from interface: CaseInstanceMigrationBuilder

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

Specified by:

validateMigrationOfCaseInstances in interface CaseInstanceMigrationBuilder

Returns:

a CaseInstanceMigrationValidationResult that contains validation error messages - if any

See Also:

• CaseInstanceMigrationValidationResult

getCmmnMigrationService

protected CmmnMigrationService getCmmnMigrationService()