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

Class HistoricCaseInstanceMigrationBuilderImpl

java.lang.Object

org.flowable.cmmn.engine.impl.migration.HistoricCaseInstanceMigrationBuilderImpl

All Implemented Interfaces:

HistoricCaseInstanceMigrationBuilder

public class HistoricCaseInstanceMigrationBuilderImpl
extends Object
implements HistoricCaseInstanceMigrationBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected CmmnMigrationService	cmmnMigrationService
protected HistoricCaseInstanceMigrationDocumentBuilderImpl	historicCaseInstanceMigrationDocumentDocumentBuilder

Constructor Summary

Constructors

Constructor	Description
HistoricCaseInstanceMigrationBuilderImpl(CmmnMigrationService cmmnMigrationService)

Method Summary

Modifier and Type	Method	Description
Batch	batchMigrateHistoricCaseInstances(String caseDefinitionId)	Starts the case instance migration for all case instances of a given case definition identified by the case definition id.
Batch	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).
HistoricCaseInstanceMigrationBuilder	fromHistoricCaseInstanceMigrationDocument(HistoricCaseInstanceMigrationDocument caseInstanceMigrationDocument)	Creates a HistoricCaseInstanceMigrationBuilder using the values of a HistoricCaseInstanceMigrationDocument
protected CmmnMigrationService	getCmmnMigrationService()
HistoricCaseInstanceMigrationDocument	getHistoricCaseInstanceMigrationDocument()	Builds a HistoricCaseInstanceMigrationDocument
void	migrate(String caseInstanceId)	Starts the case instance migration for a case identified with the submitted caseInstanceId
void	migrateHistoricCaseInstances(String caseDefinitionId)	Asynchronously starts the case instance migration for each case instances of a given case definition identified by the case definition id.
void	migrateHistoricCaseInstances(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).
HistoricCaseInstanceMigrationBuilder	migrateToCaseDefinition(String caseDefinitionId)	Specifies the case definition to migrate to, using the case definition id
HistoricCaseInstanceMigrationBuilder	migrateToCaseDefinition(String caseDefinitionKey, int caseDefinitionVersion)	Specifies the case definition to migrate to, identified by its key and version
HistoricCaseInstanceMigrationBuilder	migrateToCaseDefinition(String caseDefinitionKey, int caseDefinitionVersion, String caseDefinitionTenantId)	Specifies the case definition to migrate to, identified by its key and version and tenantId
HistoricCaseInstanceMigrationBuilder	withMigrateToCaseDefinitionTenantId(String caseDefinitionTenantId)	Specifies the tenantId of the case definition to migrate to

Methods inherited from class java.lang.Object

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

Field Details

cmmnMigrationService

protected CmmnMigrationService cmmnMigrationService

historicCaseInstanceMigrationDocumentDocumentBuilder

protected HistoricCaseInstanceMigrationDocumentBuilderImpl historicCaseInstanceMigrationDocumentDocumentBuilder

Constructor Details

HistoricCaseInstanceMigrationBuilderImpl

public HistoricCaseInstanceMigrationBuilderImpl(CmmnMigrationService cmmnMigrationService)

Method Details

fromHistoricCaseInstanceMigrationDocument

public HistoricCaseInstanceMigrationBuilder fromHistoricCaseInstanceMigrationDocument(HistoricCaseInstanceMigrationDocument caseInstanceMigrationDocument)

Description copied from interface: HistoricCaseInstanceMigrationBuilder

Creates a HistoricCaseInstanceMigrationBuilder using the values of a HistoricCaseInstanceMigrationDocument

Specified by:

fromHistoricCaseInstanceMigrationDocument in interface HistoricCaseInstanceMigrationBuilder

Parameters:

caseInstanceMigrationDocument - Migration document with pre-filled case information

Returns:

Returns the builder

See Also:

• HistoricCaseInstanceMigrationDocument

migrateToCaseDefinition

public HistoricCaseInstanceMigrationBuilder migrateToCaseDefinition(String caseDefinitionId)

Description copied from interface: HistoricCaseInstanceMigrationBuilder

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

Specified by:

migrateToCaseDefinition in interface HistoricCaseInstanceMigrationBuilder

Parameters:

caseDefinitionId - ID of the case definition to migrate to

Returns:

Returns the builder

See Also:

• CaseDefinition

migrateToCaseDefinition

public HistoricCaseInstanceMigrationBuilder migrateToCaseDefinition(String caseDefinitionKey,
 int caseDefinitionVersion)

Description copied from interface: HistoricCaseInstanceMigrationBuilder

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

Specified by:

migrateToCaseDefinition in interface HistoricCaseInstanceMigrationBuilder

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 HistoricCaseInstanceMigrationBuilder migrateToCaseDefinition(String caseDefinitionKey,
 int caseDefinitionVersion,
 String caseDefinitionTenantId)

Description copied from interface: HistoricCaseInstanceMigrationBuilder

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

Specified by:

migrateToCaseDefinition in interface HistoricCaseInstanceMigrationBuilder

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 HistoricCaseInstanceMigrationBuilder withMigrateToCaseDefinitionTenantId(String caseDefinitionTenantId)

Description copied from interface: HistoricCaseInstanceMigrationBuilder

Specifies the tenantId of the case definition to migrate to

Specified by:

withMigrateToCaseDefinitionTenantId in interface HistoricCaseInstanceMigrationBuilder

Parameters:

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

Returns:

Returns the builder

getHistoricCaseInstanceMigrationDocument

public HistoricCaseInstanceMigrationDocument getHistoricCaseInstanceMigrationDocument()

Description copied from interface: HistoricCaseInstanceMigrationBuilder

Builds a HistoricCaseInstanceMigrationDocument

Specified by:

getHistoricCaseInstanceMigrationDocument in interface HistoricCaseInstanceMigrationBuilder

Returns:

Returns the builder

See Also:

• HistoricCaseInstanceMigrationDocument

migrate

public void migrate(String caseInstanceId)

Description copied from interface: HistoricCaseInstanceMigrationBuilder

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

Specified by:

migrate in interface HistoricCaseInstanceMigrationBuilder

migrateHistoricCaseInstances

public void migrateHistoricCaseInstances(String caseDefinitionId)

Description copied from interface: HistoricCaseInstanceMigrationBuilder

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

Specified by:

migrateHistoricCaseInstances in interface HistoricCaseInstanceMigrationBuilder

batchMigrateHistoricCaseInstances

public Batch batchMigrateHistoricCaseInstances(String caseDefinitionId)

Description copied from interface: HistoricCaseInstanceMigrationBuilder

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

Specified by:

batchMigrateHistoricCaseInstances in interface HistoricCaseInstanceMigrationBuilder

migrateHistoricCaseInstances

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

Description copied from interface: HistoricCaseInstanceMigrationBuilder

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:

migrateHistoricCaseInstances in interface HistoricCaseInstanceMigrationBuilder

batchMigrateHistoricCaseInstances

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

Description copied from interface: HistoricCaseInstanceMigrationBuilder

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:

batchMigrateHistoricCaseInstances in interface HistoricCaseInstanceMigrationBuilder

Returns:

an id of the created batch entity

getCmmnMigrationService

protected CmmnMigrationService getCmmnMigrationService()