View Javadoc
1   /**
2    * This file Copyright (c) 2014-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.ui.contentapp.browser.action;
35  
36  import info.magnolia.ui.api.action.CommandActionDefinition;
37  
38  
39  /**
40   * ActionDefinition used for restoring the previous version of an item and its descendants which are in the mgnl: namespace.
41   * The default settings are
42   * <ul>
43   * <li>the action is async
44   * <li>the command name is set to restorePreviousVersion
45   * <li>parentNodeTypeOnly is false
46   * </ul>
47   * These settings can be changed for specific cases both in subclasses or directly in the config tree.
48   */
49  public class RestoreItemPreviousVersionActionDefinition extends CommandActionDefinition {
50  
51      private boolean parentNodeTypeOnly = false;
52  
53      public RestoreItemPreviousVersionActionDefinition() {
54          setImplementationClass(RestoreItemPreviousVersionAction.class);
55          setAsynchronous(true);
56          setCommand("restorePreviousVersion");
57      }
58  
59      /**
60       * Set to true, if one wants to restore all descendants whose type is the same as the parent one.
61       */
62      public void setParentNodeTypeOnly(boolean parentNodeTypeOnly) {
63          this.parentNodeTypeOnly = parentNodeTypeOnly;
64      }
65  
66      /**
67       * @return true, if one wants to restore all descendants whose type is the same as the parent one. Default value is false.
68       */
69      public boolean isParentNodeTypeOnly() {
70          return parentNodeTypeOnly;
71      }
72  }