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

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