From: jprocter <jprocter@compbio.dundee.ac.uk>
Date: Mon, 23 Jan 2006 10:53:19 +0000 (+0000)
Subject: added some more comments about event types/implementation
X-Git-Tag: Release_0.2~358
X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=3b046648062b93ab88457cc7cb93b0f5faa2f8d3;p=vamsas.git

added some more comments about event types/implementation

git-svn-id: https://svn.lifesci.dundee.ac.uk/svn/repository/trunk@162 be28352e-c001-0410-b1a7-c7978e42abec
---

diff --git a/src/org/vamsas/client/Events.java b/src/org/vamsas/client/Events.java
index 00512a7..babd39c 100644
--- a/src/org/vamsas/client/Events.java
+++ b/src/org/vamsas/client/Events.java
@@ -44,20 +44,23 @@ public class Events {
    * allow them to store any updates before an offline copy of the session is
    * created. Any client that handles this should call the
    * IClient.getDocument(), update and then IClient.updateDocument in the same
-   * handler thread.
+   * handler thread (the lock on the document is held until the handler exits).
    * EventName: <Vamsas-session URN>
    * NewValue: org.vamsas.client.IClient for session.
    */
   public static final String DOCUMENT_FINALIZEAPPDATA = "org.vamsas.client.events.DocumentFinalizeAppData";
 
   /**
-   * Generated by Vorba stub after the penultimate client makes a call to
-   * closeDocument(). Sequence is as follows : 1. All other vamsas clients have
-   * called closeDocument() 2. Final living client monitors closures, and
+   * Generated by Vorba stub for the sole remaining client, after the penultimate 
+   * client makes a call to finalizeClient(). It is only raised if the session has been modifies since the 
+   * last call to storeDocument() by any application.
+   * TODO: LATER: copies of a document should be on a per-user basis for multi-user sessions. 
+   *  Sequence is as follows : 1. All other vamsas clients have
+   * called finalizeClient() 2. Final living client monitors closures, and
    * realises that it is last. 3. Final client generates event to prompt
    * associated application to inquire if the user wishes to save the document
    * for future reference.
-   *  * Any call to closeDocument in a thread other than the registered
+   *  * Any call to finalizeClient in a thread other than the registered
    * EventListener will block until the RequestToClose handler has exited.
    * 
    */