bundles/org.simantics.databoard/src/org/simantics/databoard/channel/ServiceHandler.java

   1 package org.simantics.databoard.channel;\r
   2 \r
   3 import java.util.Collection;\r
   4 \r
   5 /**\r
   6  * Server interface of command channel. <p>\r
   7  * \r
   8  * For each callable command there is a well-known commandId and datatype. <p>\r
   9  *\r
  10  * @author Toni Kalajainen <toni.kalajainen@iki.fi>\r
  11  */\r
  12 public interface ServiceHandler {\r
  13 \r
  14         /**\r
  15          * Handle service request from the client. The implementation may handle\r
  16          * the service at once or later, even in another thread. The result is\r
  17          * written to the asynchronous result object. <p>\r
  18          * \r
  19          * @param request\r
  20          */\r
  21         void handleRequest( ServiceRequest request );\r
  22         \r
  23         /**\r
  24          * Get all callable commands handled by this service handler.\r
  25          * This result is list of command specifications. For each command there is\r
  26          * unique identification, result type and error type.  \r
  27          * \r
  28          * @return commands\r
  29          */\r
  30         Collection<CommandSpec> getCommands();\r
  31         \r
  32 }\r