package org.vamsas.client;
import java.beans.PropertyChangeListener;
-import java.util.EventListener;
/**
* Defines the methods availabable to a vamsas
/**
* register handler for updates for the current session
*/
- public void addDocumentUpdateHandler(EventListener evt);
+ public void addDocumentUpdateHandler(PropertyChangeListener evt);
/**
* get vamsas document with
* user and app specific data
* Queue new Vorba objects for storage and propagation
* to other clients (via Event.DOCUMENT_UPDATE based
* notification of document change)
+ * New objects without provenance information will be
+ * given a default entry using the IClient's application,
+ * user (and session) handles
*/
public void updateDocument(IClientDocument newdoc);
/**
public void storeDocument(java.io.File location);
/**
* Add a listener to a particular event chain.
- * See org.vamsas.client.Events for allowed values for EventChain.
- * The EventChain value is passed as the propertyName in the java.bean.PropertyChangeEvent
- * TODO: build our own vamsas Event/Listener model.
+ * See org.vamsas.client.Events for allowed
+ * values for EventChain.
+ * The EventChain value is passed as the
+ * propertyName in the java.bean.PropertyChangeEvent
+ * TODO: extend class to form own vamsas Event/Listener model.
* @param EventChain Name of event. Blank/null registers handler for all events.
* @param evt - event handler function.
*/
public void addVorbaEventHandler(String EventChain, PropertyChangeListener evt);
+ /**
+ * client application calls this to force the
+ * Vorba client to check for updates immediately.
+ *
+ */
+ public void pollUpdate();
+
+ /**
+ * Client application calls this after any pre-session initialization
+ * (registering of Handlers, etc)
+ * Exceptions are raised for any failures. Any stateful calls to the session prior to
+ * this will result in an implicit call to joinSession - if that results in an exception
+ * then the VamsasClient should raise an Error.
+ * TODO: create VAMSAS exception hierarchy (in a language agnostic manner)
+ */
+ public void joinSession() throws Exception;
}