Package org.flowable.common.engine.api.tenant

# Interface ChangeTenantIdBuilder

public interface ChangeTenantIdBuilder
Helper for changing the tenant id from active and historic instances.

An instance can be created with the corresponding management service of each of the BPMN, CMMN or DMN scopes.

Author:
  Jorge Mora Giménez, Filip Hrisafov

- ## Method Summary

  Modifier and Type
  Method
  Description
  `ChangeTenantIdResult`
  `complete()`
  Executes change in the tenant id, returning the number of instances that were affected
  `ChangeTenantIdBuilder`
  `definitionTenantId(String definitionTenantId)`
  Perform the change only for instances that were created using a definition from the given tenant.
  `ChangeTenantIdResult`
  `simulate()`
  Executes a simulation of the change of tenant id, calculating the number of instances that will be affected

- ## Method Details

  - ### definitionTenantId

    ChangeTenantIdBuilder definitionTenantId(String definitionTenantId)
    Perform the change only for instances that were created using a definition from the given tenant.

  - ### simulate

    ChangeTenantIdResult simulate()
    Executes a simulation of the change of tenant id, calculating the number of instances that will be affected
    Returns:
      `ChangeTenantIdResult`

  - ### complete

    ChangeTenantIdResult complete()
    Executes change in the tenant id, returning the number of instances that were affected
    Returns:
      `ChangeTenantIdResult`