KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > riotfamily > riot > list > command > Command


1 /* ***** BEGIN LICENSE BLOCK *****
2  * Version: MPL 1.1
3  * The contents of this file are subject to the Mozilla Public License Version
4  * 1.1 (the "License"); you may not use this file except in compliance with
5  * the License. You may obtain a copy of the License at
6  * http://www.mozilla.org/MPL/
7  *
8  * Software distributed under the License is distributed on an "AS IS" basis,
9  * 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 /**
28  * Interface to be implemented by classes that perform operations on lists
29  * or list items.
30  *
31  * NOTE: Implementations must be thread-safe.
32  */
33 public interface Command {
34
35     /**
36      * Returns a unique identifier used to reference the command.
37      */
38     public String JavaDoc getId();
39     
40     /**
41      * Executes the command.
42      */
43     public CommandResult execute(CommandContext context);
44
45     /**
46      * Returns a localized message that is displayed to the user asking for
47      * a confirmation. Implementors may return <code>null</code> if no
48      * confirmation is needed. Otherwise a dialog containing an <i>Ok</i> and a
49      * <i>Cancel</i> button is displayed. If the user clicks <i>Ok</i>
50      * the command is executed otherwise no action takes place.
51      */
52     public String JavaDoc getConfirmationMessage(CommandContext context);
53     
54     /**
55      * @since 6.5
56      */
57     public CommandState getState(CommandContext context);
58
59     /**
60      * Returns whether the command should be shown beside the form.
61      */
62     public boolean isShowOnForm();
63 }
64
Popular Tags