org.camunda.bpm.engine.migration.MigrationPlanBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camunda-bpm-engine-api Show documentation

There is a newer version: 7.22.0

Show newest version

/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. Camunda licenses this file to you under the Apache License,
 * Version 2.0; you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.camunda.bpm.engine.migration;

import org.camunda.bpm.engine.AuthorizationException;
import org.camunda.bpm.engine.authorization.Permissions;
import org.camunda.bpm.engine.authorization.Resources;

/**
 * @author Thorben Lindhauer
 *
 */
public interface MigrationPlanBuilder {

  /**
   * Automatically adds a set of instructions for activities that are equivalent in both
   * process definitions. By default, this is given if two activities are both user tasks, are on the same
   * level of sub process, and have the same id.
   */
  MigrationInstructionsBuilder mapEqualActivities();

  /**
   * Adds a migration instruction that maps activity instances of the source activity (of the source process definition)
   * to activity instances of the target activity (of the target process definition)
   */
  MigrationInstructionBuilder mapActivities(String sourceActivityId, String targetActivityId);

  /**
   * @return a migration plan with all previously specified instructions
   *
   * @throws MigrationPlanValidationException if the migration plan contains instructions that are not valid
   * @throws AuthorizationException
   *         if the user has no {@link Permissions#READ} permission on {@link Resources#PROCESS_DEFINITION}
   *         for both, source and target process definition.
   */
  MigrationPlan build();


}