bundles/org.simantics.diagram/src/org/simantics/diagram/handler/CopyStrategy.java

   1 /*******************************************************************************
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management
   3  * in Industry THTH ry.
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *     VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.diagram.handler;
  13
  14 import org.eclipse.core.runtime.IStatus;
  15
  16 /**
  17  * An additional interface for {@link CopyPasteStrategy} implementation to
  18  * implement. This can be used to control the set of elements allowed to be
  19  * copied/cut in the first place.
  20  *
  21  * @author Tuukka Lehtonen
  22  * @see CopyPasteStrategy
  23  * @since 1.23
  24  */
  25 public interface CopyStrategy {
  26
  27     /**
  28      * @param operation
  29      *            the contents of the intended copy that this method is allowed
  30      *            to modify freely.
  31      * @return status to indicate whether the copy operation can succeed or not.
  32      *         An OK status indicates the copy operation is ok to commence. Any
  33      *         other status means that the strategy prevented copy the reason
  34      *         shown by the status.
  35      */
  36     IStatus copy(CopyOperation operation);
  37
  38 }