eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/operation/IPostOperationEnabled.java

   1 /**
   2  * Copyright (C) 2007 EDIT
   3  * European Distributed Institute of Taxonomy
   4  * http://www.e-taxonomy.eu
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version 1.1
   7  * See LICENSE.TXT at the top of this package for the full license terms.
   8  */
   9
  10 package eu.etaxonomy.taxeditor.operation;
  11
  12 import org.eclipse.core.runtime.Status;
  13
  14 /**
  15  * Implementors may register to operations. The postOperation method will get
  16  * called after any post operation
  17  *
  18  * @author n.hoffmann
  19  * @created 24.03.2009
  20  * @version 1.0
  21  */
  22 public interface IPostOperationEnabled {
  23
  24         /**
  25          * <p>
  26          * This method will be called after executing an operation. If operation
  27          * created a new object and the {@link IPostOperationEnabled} has to know
  28          * about the object it should be passed to the {@link IPostOperationEnabled}
  29          * </p>
  30          *
  31          * @param objectAffectedByOperation
  32          *            a newly created object for example. May be <code>null</code>
  33          * @return true if the method executed successfully. Returning false will
  34          *         set the operations status to {@link Status.CANCEL_STATUS} which
  35          *         might not be what you want.
  36          */
  37         public boolean postOperation(Object objectAffectedByOperation);
  38
  39         /**
  40          * This method will get called after the execution took place and occasional
  41          * cleanups were performed. This is typically the last thing to happen.
  42          *
  43          * @return a boolean.
  44          */
  45         public boolean onComplete();
  46
  47 }