uk.ac.vamsas.client
Class Events

java.lang.Object
  extended byuk.ac.vamsas.client.Events

public class Events
extends java.lang.Object

Enumerates the event types generated during the lifecycle of a Vamsas session. See the excel spreadsheet in VamsasClient/docs/VamsasSessionEventAnalysis.xls for some more information about when these are generated and how they should be handled.


Field Summary
static java.lang.String CLIENT_CREATION
          Generated when a new vamsas client is attached to a session (Handle is passed) Note: the newly created client does not receive the event.
static java.lang.String CLIENT_FINALIZATION
          Generated when a vamsas client leaves a session (Handle is passed to all others).
static java.lang.String DOCUMENT_CREATE
          Generated when a new vamsas document is created (perhaps from some existing Vamsas data) so an application may do its own data space initialization.
static java.lang.String DOCUMENT_FINALIZEAPPDATA
          Generated for all clients when any client calls IClient.storeDocument() to allow them to store any updates before an offline copy of the session is created.
static java.lang.String DOCUMENT_REQUESTTOCLOSE
          Generated by Vorba stub for the sole remaining client instance in a session, when it makes a call to finalizeClient().
static java.lang.String DOCUMENT_UPDATE
          Generated when a client has finished updating the document.
static java.util.Vector EventList
           
static java.lang.String SESSION_SHUTDOWN
          Generated prior to session Shutdown, after the last participating vamsas client has finalized.
 
Constructor Summary
Events()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DOCUMENT_UPDATE

public static final java.lang.String DOCUMENT_UPDATE
Generated when a client has finished updating the document. Client which has completed an update should not receive the event. NewValue: uk.ac.vamsas.client.IClient for session.

See Also:
Constant Field Values

DOCUMENT_CREATE

public static final java.lang.String DOCUMENT_CREATE
Generated when a new vamsas document is created (perhaps from some existing Vamsas data) so an application may do its own data space initialization. Raised for a new application connecting to a vamsas document NewValue: uk.ac.vamsas.client.IClient for session. LATER: DOCUMENT_CREATE event may be redundant

See Also:
Constant Field Values

CLIENT_CREATION

public static final java.lang.String CLIENT_CREATION
Generated when a new vamsas client is attached to a session (Handle is passed) Note: the newly created client does not receive the event.

See Also:
Constant Field Values

CLIENT_FINALIZATION

public static final java.lang.String CLIENT_FINALIZATION
Generated when a vamsas client leaves a session (Handle is passed to all others).

See Also:
Constant Field Values

SESSION_SHUTDOWN

public static final java.lang.String SESSION_SHUTDOWN
Generated prior to session Shutdown, after the last participating vamsas client has finalized. Probably only useful to IClientFactory implementations. NewValue:

See Also:
Constant Field Values

DOCUMENT_FINALIZEAPPDATA

public static final java.lang.String DOCUMENT_FINALIZEAPPDATA
Generated for all clients when any client calls IClient.storeDocument() to 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 (the lock on the document is held until the handler exits). EventName: NewValue: uk.ac.vamsas.client.IClient for session.

See Also:
Constant Field Values

DOCUMENT_REQUESTTOCLOSE

public static final java.lang.String DOCUMENT_REQUESTTOCLOSE
Generated by Vorba stub for the sole remaining client instance in a session, when it makes a call to finalizeClient(). It is only raised if the session has been modified since the last call to storeDocument() by any application. 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 finalizeClient in a thread other than the registered EventListener will block until the RequestToClose handler has exited. NewValue: uk.ac.vamsas.client.IClient for session.

See Also:
Constant Field Values

EventList

public static java.util.Vector EventList
Constructor Detail

Events

public Events()