ist.palcom.hgraph
Interface Listener

All Known Implementing Classes:
AbstractListener, CompassListener, HgraphBrowserHgraphProxyListener, HgraphBrowserOutListener, HgraphContextListener, LiveViewListener, MirrorOutListener, SwingEngineListener, VizManagerListener

public interface Listener

Listeners provide the means for deploying a callback on a remote node.


Method Summary
 java.lang.String getDescription()
           
 java.lang.String getName()
           
 Path getReturnPath()
           
 void setNode(IHgraphNode node)
          Sets the node to call back through.
 void trigger(java.lang.String command, Value params, Path callerPath)
          trigger is called everywhen either an event is handled by the node or a triggerable event is called from within the node
 

Method Detail

getName

java.lang.String getName()
Returns:
The name of the Listener

setNode

void setNode(IHgraphNode node)
Sets the node to call back through.

Parameters:
node -

getDescription

java.lang.String getDescription()
Returns:
A description of the listener in prose. It should as a minimum describe the commands the listener is listening on and how it reacts on those commands

trigger

void trigger(java.lang.String command,
             Value params,
             Path callerPath)
trigger is called everywhen either an event is handled by the node or a triggerable event is called from within the node

Parameters:
command -
params -

getReturnPath

Path getReturnPath()
Returns:
the path of the recipient node of the triggered events