org.camunda.bpm.engine.migration.MigrationPlan Maven / Gradle / Ivy
/*
* 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 java.util.List;
/**
* Specifies how process instances from one process definition (the source process definition)
* should be migrated to another process definition (the target process definition).
*
*
A migration plan consists of a number of {@link MigrationInstruction}s that tell which
* activity maps to which. The set of instructions is complete, i.e. the migration logic does not perform
* migration steps that are not given by the instructions
*
* @author Thorben Lindhauer
*/
public interface MigrationPlan {
/**
* @return the list of instructions that this plan consists of
*/
List getInstructions();
/**
* @return the id of the process definition that is migrated from
*/
String getSourceProcessDefinitionId();
/**
* @return the id of the process definition that is migrated to
*/
String getTargetProcessDefinitionId();
}