src/core/net/sf/basedb/util/extensions/Action.java

Code
Comments
Other
Rev Date Author Line
4158 22 Feb 08 nicklas 1 /**
4198 28 Mar 08 nicklas 2   $Id:Action.java 4187 2008-03-20 11:15:25Z nicklas $
4158 22 Feb 08 nicklas 3
4158 22 Feb 08 nicklas 4   Copyright (C) Authors contributing to this file.
4158 22 Feb 08 nicklas 5
4158 22 Feb 08 nicklas 6   This file is part of BASE - BioArray Software Environment.
4158 22 Feb 08 nicklas 7   Available at http://base.thep.lu.se/
4158 22 Feb 08 nicklas 8
4158 22 Feb 08 nicklas 9   BASE is free software; you can redistribute it and/or
4158 22 Feb 08 nicklas 10   modify it under the terms of the GNU General Public License
4479 05 Sep 08 jari 11   as published by the Free Software Foundation; either version 3
4158 22 Feb 08 nicklas 12   of the License, or (at your option) any later version.
4158 22 Feb 08 nicklas 13
4158 22 Feb 08 nicklas 14   BASE is distributed in the hope that it will be useful,
4158 22 Feb 08 nicklas 15   but WITHOUT ANY WARRANTY; without even the implied warranty of
4158 22 Feb 08 nicklas 16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
4158 22 Feb 08 nicklas 17   GNU General Public License for more details.
4158 22 Feb 08 nicklas 18
4158 22 Feb 08 nicklas 19   You should have received a copy of the GNU General Public License
4515 11 Sep 08 jari 20   along with BASE. If not, see <http://www.gnu.org/licenses/>.
4158 22 Feb 08 nicklas 21 */
4158 22 Feb 08 nicklas 22 package net.sf.basedb.util.extensions;
4158 22 Feb 08 nicklas 23
4158 22 Feb 08 nicklas 24 /**
4158 22 Feb 08 nicklas 25   An action is an object that is added to an {@link ExtensionPoint}
4158 22 Feb 08 nicklas 26   by an {@link Extension}. Each action usually results in some visual
4158 22 Feb 08 nicklas 27   element, for example, a button or menu item. This is a tagging
4158 22 Feb 08 nicklas 28   interface that needs to be implemented by all action objects.
4158 22 Feb 08 nicklas 29   <p>
4198 28 Mar 08 nicklas 30   This interface is usually subclassed for specific types of actions.
4198 28 Mar 08 nicklas 31   It is the extension point that decides which action class that
4158 22 Feb 08 nicklas 32   can be used in that particular extension point. See
4158 22 Feb 08 nicklas 33   {@link ExtensionPoint#getActionClass()}.
4158 22 Feb 08 nicklas 34   <p>
4158 22 Feb 08 nicklas 35   The core doesn't define any actual action implementations, since they
4198 28 Mar 08 nicklas 36   always depends on the client application. For examples,
4158 22 Feb 08 nicklas 37   see the web client extensions {@link net.sf.basedb.clients.web.extensions}.
4158 22 Feb 08 nicklas 38
4158 22 Feb 08 nicklas 39   @author nicklas
4158 22 Feb 08 nicklas 40   @version 2.7
4198 28 Mar 08 nicklas 41   @base.modified $Date:2008-03-20 12:15:25 +0100 (Thu, 20 Mar 2008) $
4158 22 Feb 08 nicklas 42 */
4158 22 Feb 08 nicklas 43 public interface Action
4158 22 Feb 08 nicklas 44 {}