1 package org.vamsas.client;
4 * Enumerates the event types generated during the lifecycle of a Vamsas
10 * Generated when a client has finished updating the document. Passes
11 * applicationHandle of client so the updating client can recognise its own
14 public static final String DOCUMENT_UPDATE = "org.vamsas.client.events.documentUpdateEvent";
17 * Generated when a new vamsas document is created (perhaps from some existing
18 * Vamsas data) so an application may do its own data space initialization.
19 * TODO: decide if this is called when an app is connected to a stored
22 public static final String DOCUMENT_CREATE = "org.vamsas.client.events.documentCreateEvent";
25 * Generated when a new vamsas client is attached to a session (Handle is
26 * passed) Note: the newly created client does not receive the event.
28 public static final String CLIENT_CREATION = "org.vamsas.client.events.clientCreateEvent";
31 * Generated when a vamsas client leaves a session (Handle is passed to all
34 public static final String CLIENT_FINALIZATION = "org.vamsas.client.events.clientFinalizationEvent";
37 * Generated prior to session Shutdown, after the last participating vamsas
38 * client has finalized.
40 public static final String SESSION_SHUTDOWN = "org.vamsas.client.events.SessionShutdownEvent";
43 * Generated for all clients when any client calls IClient.storeDocument() to
44 * allow them to store any updates before an offline copy of the session is
45 * created. Any client that handles this should call the
46 * IClient.getDocument(), update and then IClient.updateDocument in the same
49 public static final String DOCUMENT_FINALIZEAPPDATA = "org.vamsas.client.events.DocumentFinalizeAppData";
52 * Generated by Vorba stub after the penultimate client makes a call to
53 * closeDocument(). Sequence is as follows : 1. All other vamsas clients have
54 * called closeDocument() 2. Final living client monitors closures, and
55 * realises that it is last. 3. Final client generates event to prompt
56 * associated application to inquire if the user wishes to save the document
57 * for future reference.
58 * * Any call to closeDocument in a thread other than the registered
59 * EventListener will block until the RequestToClose handler has exited.
62 public static final String DOCUMENT_REQUESTTOCLOSE = "org.vamas.client.DocumentRequestToCloseEvent";
64 public static java.util.Vector EventList = initList();
66 private static java.util.Vector initList() {
67 java.util.Vector vec = new java.util.Vector();
68 vec.add((Object) DOCUMENT_UPDATE);
69 vec.add((Object) DOCUMENT_CREATE);
70 vec.add((Object) CLIENT_CREATION);
71 vec.add((Object) CLIENT_FINALIZATION);
72 vec.add((Object) SESSION_SHUTDOWN);
73 vec.add((Object) DOCUMENT_REQUESTTOCLOSE);
74 vec.add((Object) DOCUMENT_FINALIZEAPPDATA);