View Javadoc

1   /*
2   Copyright (C) 2000 - 2007 Grid Systems, S.A.
3   
4   This program is free software; you can redistribute it and/or modify
5   it under the terms of the GNU General Public License, version 2, as
6   published by the Free Software Foundation.
7   
8   This program is distributed in the hope that it will be useful,
9   but WITHOUT ANY WARRANTY; without even the implied warranty of
10  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  GNU General Public License for more details.
12  
13  You should have received a copy of the GNU General Public License
14  along with this program; if not, write to the Free Software
15  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  */
17  
18  /*
19   * Project: KernelConfigurator
20   * Created on 03-mar-2004
21   *
22   * Copyright (c)2003 Grid Systems
23   */
24  package com.gridsystems.config.tools.console;
25  
26  import com.gridsystems.config.ConsoleConfiguratorView;
27  
28  
29  /**
30   * Classes implementing this interface can be called from a console view to
31   * perform a single task.
32   *
33   * @author <a href="mailto:rruiz@gridsystems.com">Rodrigo Ruiz Aguayo</a>
34   * @version 1.0
35   */
36  public interface ConsoleViewAction {
37    /**
38     * Gets the key mapping of this action.
39     *
40     * @return The key mapping of this action
41     */
42    String getKeyMapping();
43  
44    /**
45     * Performs a task related to the specified view.
46     *
47     * @param view The view invoking the execution
48     * @return false if the view must exit from its execution loop; true otherwise
49     */
50    boolean execute(ConsoleConfiguratorView view);
51  }