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.ui.api.action;
35  
36  import info.magnolia.ui.api.availability.AvailabilityDefinition;
37  import info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition;
38  
39  /**
40   * Simple implementation of {@link ActionDefinition}.
41   */
42  public class ConfiguredActionDefinition implements ActionDefinition {
43  
44      private String name;
45      private String label;
46      private String description;
47      private String icon;
48      private String i18nBasename;
49      private Class<? extends Action> implementationClass;
50      private String successMessage;
51      private String failureMessage;
52      private String errorMessage;
53      private AvailabilityDefinition availability = new ConfiguredAvailabilityDefinition();
54  
55      @Override
56      public String getName() {
57          return name;
58      }
59  
60      public void setName(String name) {
61          this.name = name;
62      }
63  
64      @Override
65      public String getLabel() {
66          return label;
67      }
68  
69      public void setLabel(String label) {
70          this.label = label;
71      }
72  
73      @Override
74      public String getDescription() {
75          return description;
76      }
77  
78      public void setDescription(String description) {
79          this.description = description;
80      }
81  
82      @Override
83      public String getIcon() {
84          return icon;
85      }
86  
87      public void setIcon(String icon) {
88          this.icon = icon;
89      }
90  
91      @Override
92      public String getI18nBasename() {
93          return i18nBasename;
94      }
95  
96      public void setI18nBasename(String i18nBasename) {
97          this.i18nBasename = i18nBasename;
98      }
99  
100     @Override
101     public Class<? extends Action> getImplementationClass() {
102         return implementationClass;
103     }
104 
105     public void setImplementationClass(Class<? extends Action> implementationClass) {
106         this.implementationClass = implementationClass;
107     }
108 
109     @Override
110     public AvailabilityDefinition getAvailability() {
111         return this.availability;
112     }
113 
114     @Override
115     public String getSuccessMessage() {
116         return successMessage;
117     }
118 
119     public void setSuccessMessage(String successMessage) {
120         this.successMessage = successMessage;
121     }
122 
123     @Override
124     public String getFailureMessage() {
125         return failureMessage;
126     }
127 
128     public void setFailureMessage(String failureMessage) {
129         this.failureMessage = failureMessage;
130     }
131 
132     @Override
133     public String getErrorMessage() {
134         return errorMessage;
135     }
136 
137     public void setErrorMessage(String errorMessage) {
138         this.errorMessage = errorMessage;
139     }
140 
141     public void setAvailability(AvailabilityDefinition availability) {
142         this.availability = availability;
143     }
144 }
145