1 /**
2 * This file Copyright (c) 2011-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.i18nsystem.I18nText;
37 import info.magnolia.i18nsystem.I18nable;
38 import info.magnolia.ui.api.availability.AvailabilityDefinition;
39
40 /**
41 * Action definitions are used to configure actions in many parts of the UI. The definition holds a name which is used
42 * to identify the action within a certain scope, for instance within a sub app. Many actions have dedicated action
43 * definition classes implementing this interface that allows supplying additional parameters to the action.
44 * Implementations are expected to provide correct {@link Object#equals(Object)} and {@link Object#hashCode()} methods.
45 *
46 * @see Action
47 * @see ActionExecutor
48 */
49 @I18nable(keyGenerator = ActionDefinitionKeyGenerator.class)
50 public interface ActionDefinition {
51
52 String getName();
53
54 @I18nText
55 String getLabel();
56
57 String getIcon();
58
59 String getI18nBasename();
60
61 @I18nText
62 String getDescription();
63
64 @I18nText
65 String getSuccessMessage();
66
67 @I18nText
68 String getFailureMessage();
69
70 @I18nText
71 String getErrorMessage();
72
73 Class<? extends Action> getImplementationClass();
74
75 AvailabilityDefinition getAvailability();
76
77 default int getShortcut() {
78 return -1;
79 }
80 }