01: /* ***** BEGIN LICENSE BLOCK *****
02: * Version: MPL 1.1
03: * The contents of this file are subject to the Mozilla Public License Version
04: * 1.1 (the "License"); you may not use this file except in compliance with
05: * the License. You may obtain a copy of the License at
06: * http://www.mozilla.org/MPL/
07: *
08: * Software distributed under the License is distributed on an "AS IS" basis,
09: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
10: * for the specific language governing rights and limitations under the
11: * License.
12: *
13: * The Original Code is Riot.
14: *
15: * The Initial Developer of the Original Code is
16: * Neteye GmbH.
17: * Portions created by the Initial Developer are Copyright (C) 2006
18: * the Initial Developer. All Rights Reserved.
19: *
20: * Contributor(s):
21: * Felix Gnass [fgnass at neteye dot de]
22: *
23: * ***** END LICENSE BLOCK ***** */
24: package org.riotfamily.riot.list.command;
25:
26: /**
27: * Interface to be implemented by classes that perform operations on lists
28: * or list items.
29: *
30: * NOTE: Implementations must be thread-safe.
31: */
32: public interface Command {
33:
34: /**
35: * Returns a unique identifier used to reference the command.
36: */
37: public String getId();
38:
39: /**
40: * Executes the command.
41: */
42: public CommandResult execute(CommandContext context);
43:
44: /**
45: * Returns a localized message that is displayed to the user asking for
46: * a confirmation. Implementors may return <code>null</code> if no
47: * confirmation is needed. Otherwise a dialog containing an <i>Ok</i> and a
48: * <i>Cancel</i> button is displayed. If the user clicks <i>Ok</i>
49: * the command is executed otherwise no action takes place.
50: */
51: public String getConfirmationMessage(CommandContext context);
52:
53: /**
54: * @since 6.5
55: */
56: public CommandState getState(CommandContext context);
57:
58: /**
59: * Returns whether the command should be shown beside the form.
60: */
61: public boolean isShowOnForm();
62: }
|