KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mmbase > module > builders > vwms > VwmInterface


1 /*
2
3 This software is OSI Certified Open Source Software.
4 OSI Certified is a certification mark of the Open Source Initiative.
5
6 The license (Mozilla version 1.0) can be read at the MMBase site.
7 See http://www.MMBase.org/license
8
9 */
10 package org.mmbase.module.builders.vwms;
11
12 import org.mmbase.module.core.*;
13 import org.mmbase.module.builders.*;
14
15 /**
16  * Virtual Web Master interface.
17  * A VWM should implement this interface.
18  * The routines defined here are entry routines for initializing a VWM, associating listeners (clients) with the VWM,
19  * and managing changes in local and remote nodes.
20  *
21  * @application VWMs
22  * @deprecated all known implementations extend {@link Vwm} so why use an interface?
23  * @author Daniel Ockeloen
24  * @author Pierre van Rooden (javadocs)
25  * @version $Id: VwmInterface.java,v 1.8 2005/10/05 10:58:52 michiel Exp $
26  */
27
28 public interface VwmInterface extends MMBaseObserver {
29     /**
30     * Initialize the Vwm.
31     * @param node
32     * @param Vwms The VWMs builder. It is not really necessary as this is the same as the <code>parent</code> attribute of <code>vwmnode</code>.
33     *
34     */
35     public void init(MMObjectNode node, Vwms Vwms);
36
37     /**
38     * Add a client to the listen queue of the wvm.
39     * @param client The client-object to add
40     * @return <code>true</code> if the client was added, <code>false</code> if it already existed in the queue.
41     */
42     public boolean addClient(VwmCallBackInterface client);
43
44     /**
45     * Release a client from the listen queue of the wvm.
46     * @param client The client-object to release
47     * @return <code>true</code> if the client was released, <code>false</code> if it did not exist in the queue.
48     */
49     public boolean releaseClient(VwmCallBackInterface client);
50 }
51
Popular Tags