src/uk/ac/vamsas/client/picking/IPickManager.java

   1 /*\r
   2  * This file is part of the Vamsas Client version 0.1. \r
   3  * Copyright 2009 by Jim Procter, Iain Milne, Pierre Marguerite, \r
   4  *  Andrew Waterhouse and Dominik Lindner.\r
   5  * \r
   6  * Earlier versions have also been incorporated into Jalview version 2.4 \r
   7  * since 2008, and TOPALi version 2 since 2007.\r
   8  * \r
   9  * The Vamsas Client is free software: you can redistribute it and/or modify\r
  10  * it under the terms of the GNU Lesser General Public License as published by\r
  11  * the Free Software Foundation, either version 3 of the License, or\r
  12  * (at your option) any later version.\r
  13  *  \r
  14  * The Vamsas Client is distributed in the hope that it will be useful,\r
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  17  * GNU Lesser General Public License for more details.\r
  18  * \r
  19  * You should have received a copy of the GNU Lesser General Public License\r
  20  * along with the Vamsas Client.  If not, see <http://www.gnu.org/licenses/>.\r
  21  */\r
  22 package uk.ac.vamsas.client.picking;\r
  23 \r
  24 /**\r
  25  * Interface that defines the methods required for a pick manager.\r
  26  */\r
  27 public interface IPickManager {\r
  28   /**\r
  29    * Sends a message.\r
  30    * \r
  31    * @param message\r
  32    *          the message to send\r
  33    */\r
  34   public void sendMessage(Message message);\r
  35 \r
  36   /**\r
  37    * Registers a message handler with the manager that allows the manager to\r
  38    * perform a method callback on that object whenever a message is received.\r
  39    * \r
  40    * @param handler\r
  41    *          the message handler to register\r
  42    */\r
  43   public void registerMessageHandler(IMessageHandler handler);\r
  44 \r
  45   /**\r
  46    * Shutsdown the pick manager processes, terminating any connections to other\r
  47    * clients.\r
  48    */\r
  49   public void shutdown();\r
  50 }\r