View Javadoc
1   /**
2    * This file Copyright (c) 2013-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.commands.chain;
35  
36  
37  /**
38   * A replacement for the org.apache.commons.chain.Command interface.
39   * <blockquote>A Command encapsulates a unit of processing work to be performed,
40   * whose purpose is to examine and/or modify the state of a transaction that is
41   * represented by a Context.</blockquote>
42   */
43  public interface Command extends Cloneable {
44  
45      public static final boolean CONTINUE_PROCESSING = false;
46      public static final boolean PROCESSING_COMPLETE = true;
47  
48      boolean execute(Context context) throws Exception;
49  
50      /**
51       * This method allows to create new clone of a command, so the instances in
52       * the CommandManager's catalogs are masters, and the execution always uses
53       * clone created by this method.<br />
54       * <b>NOTE:</b> CommandsManager clone the command instances by standard
55       * Java cloning mechanism. If deep copy is needed then you have to override
56       * clone method of command.
57       */
58      public Command clone() throws CloneNotSupportedException;
59  
60  }