framework/plugins/org.eclipse.app4mc.transformation/src/org/eclipse/app4mc/transformation/TransformationDefinition.java

/*******************************************************************************
 * Copyright (c) 2020 Robert Bosch GmbH.
 *
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     Robert Bosch GmbH - initial API and implementation
 *******************************************************************************/

package org.eclipse.app4mc.transformation;

/**
 * A TransformationDefinition is used to promote information on the provided
 * transformation implementation to the runtime.
 */
public interface TransformationDefinition {

	/**
	 * 
	 * @return The user friendly name of the transformation to be shown in a UI.
	 */
	String getName();

	/**
	 * 
	 * @return The description of the transformation to be shown in a UI.
	 */
	String getDescription();

	/**
	 * 
	 * @return The key of the provided m2m transformation under which the root
	 *         transformer and the configuration are registered.
	 */
	String getM2MKey();

	/**
	 * 
	 * @return The key of the provided m2t transformation under which the root
	 *         transformer and the configuration are registered.
	 */
	String getM2TKey();

}