bundles/org.simantics.db/src/org/simantics/db/procedure/ListenerBase.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.db.procedure;\r
  13 \r
  14 /**\r
  15  * \r
  16  * \r
  17  * \r
  18  * @see AsyncProcedure\r
  19  * @see AsyncMultiProcedure\r
  20  * @see SetProcedure\r
  21  * @see Procedure\r
  22  * @see MultiProcedure\r
  23  */\r
  24 public interface ListenerBase {\r
  25     \r
  26         /**\r
  27          * Informs the database client of the liveness of this procedure. After a\r
  28          * procedure says that it is disposed, it will be detached from listening to\r
  29          * request changes and allow the system to discard the procedure references\r
  30          * from the request.\r
  31          * \r
  32          * <p>\r
  33          * This return value can be either <code>true</code> or change from\r
  34          * <code>false</code> to <code>true</code>, it must never change from\r
  35          * <code>true</code> to <code>false</code>.\r
  36          * </p>\r
  37          * \r
  38          * @return\r
  39          */\r
  40         boolean isDisposed();\r
  41 \r
  42 }\r