performed javacscript:fix and worked on documentation
[taxeditor.git] / taxeditor-store / src / main / java / eu / etaxonomy / taxeditor / operations / 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.operations;
11
12 import eu.etaxonomy.cdm.model.common.CdmBase;
13
14
15
16 /**
17 * Implementors may register to operations. The postOperation method will
18 * get called after any post operation
19 *
20 * @author n.hoffmann
21 * @created 24.03.2009
22 * @version 1.0
23 */
24 public interface IPostOperationEnabled {
25
26 /**
27 * This method will be called after executing an operation.
28 * If operation created a new object and the registrar has to know about the
29 * oBject it should be passed to the registrar
30 *
31 * @param objectAffectedByOperation an occasional newly created object. May be <code>null</code>
32 * @return true the method executed succesfully
33 */
34 public boolean postOperation(CdmBase objectAffectedByOperation);
35
36 /**
37 * This method will get called after the execution took place and occasional cleanups
38 * were performed. This is typically the last thing to happen.
39 *
40 * @return a boolean.
41 */
42 public boolean onComplete();
43 }