1 /***
2 * Redistribution and use in source and binary forms, with or without
3 * modification, are permitted provided that the following conditions are
4 * met :
5 *
6 * . Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 *
9 * . Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * . The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 *
28 * $Id: ICommand.java,v 1.5 2005/08/26 18:09:36 mat007 Exp $
29 */
30
31 package jtge.engine.command;
32
33 import java.io.Serializable;
34 import jtge.engine.data.IContext;
35 import jtge.engine.user.IUser;
36
37 /***
38 * Defines a command.
39 *
40 * @author Mathieu Champlon
41 * @version $Revision: 1.5 $ $Date: 2005/08/26 18:09:36 $
42 */
43 public interface ICommand extends Serializable
44 {
45 /***
46 * Test user right.
47 *
48 * @param user the user
49 * @return whether the user has the right to issue this command or not
50 */
51 boolean validate( IUser user );
52
53 /***
54 * Execute the command.
55 *
56 * @param context the context in which to execute the command
57 */
58 void execute( IContext context );
59
60 /***
61 * Filter the command.
62 *
63 * @param filter the filter to use
64 * @return the filtered command
65 */
66 ICommand filter( IFilter filter );
67
68 /***
69 * Sort the command.
70 *
71 * @param sorter the sorter to use
72 * @return the sorted command
73 */
74 ICommand sort( ISorter sorter );
75 }