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.action;
35  
36  import info.magnolia.ui.api.action.ConfiguredActionDefinition;
37  import info.magnolia.ui.api.location.Location;
38  
39  import org.apache.commons.lang3.StringUtils;
40  
41  /**
42   * Defines an action for opening any location in the admincentral.
43   * <p>
44   * This supports setting the location type, the app name, sub-app name as well as the parameter part of the location fragment, for the target app to use.
45   *
46   * @see Location
47   */
48  public class OpenLocationActionDefinition extends ConfiguredActionDefinition {
49  
50      private String appType = Location.LOCATION_TYPE_APP;
51      private String appName = StringUtils.EMPTY;
52      private String subAppId = StringUtils.EMPTY;
53      private String parameter = StringUtils.EMPTY;
54  
55      public OpenLocationActionDefinition() {
56          setImplementationClass(OpenLocationAction.class);
57      }
58  
59      public String getAppType() {
60          return appType;
61      }
62  
63      public void setAppType(String appType) {
64          this.appType = appType;
65      }
66  
67      public String getAppName() {
68          return appName;
69      }
70  
71      public void setAppName(String appName) {
72          this.appName = appName;
73      }
74  
75      public String getSubAppId() {
76          return subAppId;
77      }
78  
79      public void setSubAppId(String subAppId) {
80          this.subAppId = subAppId;
81      }
82  
83      public String getParameter() {
84          return parameter;
85      }
86  
87      public void setParameter(String parameter) {
88          this.parameter = parameter;
89      }
90  
91  }