http://www.eclipse.org/platform: Commands (Eclipse Foundation) 
Copyright (c) 2005, 2015 IBM Corporation and others.
This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
    IBM Corporation - initial API and implementation

/*******************************************************************************
 * Copyright (c) 2005, 2015 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.core.commands.operations;



ICompositeOperation defines an undoable operation that is composed of child
operations. Requests to execute, undo, or redo a composite result in the the
execution, undo, or redo of the composite as a whole. Similarly, a request to
dispose the composite should result in all child operations being disposed.



Since:3.1
/**
 * <p>
 * ICompositeOperation defines an undoable operation that is composed of child
 * operations. Requests to execute, undo, or redo a composite result in the the
 * execution, undo, or redo of the composite as a whole. Similarly, a request to
 * dispose the composite should result in all child operations being disposed.
 * </p>
 *
 * @since 3.1
 */
public interface ICompositeOperation extends IUndoableOperation {

	

Add the specified operation as a child of this operation.



Params:
  • operation – 
           the operation to be added. If the operation instance has
           already been added, this method will have no effect.
/**
	 * <p>
	 * Add the specified operation as a child of this operation.
	 * </p>
	 *
	 * @param operation
	 *            the operation to be added. If the operation instance has
	 *            already been added, this method will have no effect.
	 */
	void add(IUndoableOperation operation);

	

Remove the specified operation from this operation.




The composite operation should dispose the operation as part of removing
it.



Params:
  • operation – 
           the operation to be removed. The operation should be disposed
           by the receiver. This method will have no effect if the
           operation instance is not already a child.
/**
	 * <p>
	 * Remove the specified operation from this operation.
	 * </p>
	 * <p>
	 * The composite operation should dispose the operation as part of removing
	 * it.
	 * </p>
	 *
	 * @param operation
	 *            the operation to be removed. The operation should be disposed
	 *            by the receiver. This method will have no effect if the
	 *            operation instance is not already a child.
	 */
	void remove(IUndoableOperation operation);
}