|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Defines the methods availabable to a vamsas application for interacting with its Vorba agent created by an IClientFactory instance for a particular session, user, and application handle. (it's VORBA, not CORBA!) LATER: add exceptions for timeouts raised when there are problems accessing session data (because another application is hogging it). LATER: think about situations when two applications both want a ClientDocument at the same time - can one have read-only access (and be told that another is about to update)
Method Summary | |
void |
addDocumentUpdateHandler(java.beans.PropertyChangeListener evt)
register handler for updates for the current session |
void |
addVorbaEventHandler(java.lang.String EventChain,
java.beans.PropertyChangeListener evt)
Add a listener to a particular event chain. |
void |
finalizeClient()
Method called by client application on exit. |
java.lang.String |
getAbout()
Self-documenting/describing info for the application to present to the user. |
IClientDocument |
getClientDocument()
get vamsas document with user and app specific data IClientDocuments are not thread-safe. |
ClientHandle |
getClientHandle()
Included for applications with several ClientHandle identities. |
IPickManager |
getPickManager()
get the Vamsas Pick Manager for registering pick handlers and sending messages for the current session. |
SessionHandle |
getSessionHandle()
Returns a valid URN for other applications to connect to the vamsas session. |
java.lang.String |
getSessionUrn()
convenience method to get the SessionUrn as a string (for passing directly to a text box...). |
IObjectUpdate |
getUpdateHandler(java.lang.Class rootObject)
|
IObjectUpdate[] |
getUpdateHandlers()
|
UserHandle |
getUserHandle()
|
void |
importDocument(java.io.File location)
Any application may call importDocument to merge a stored vamsasDocument into the current session. |
void |
joinSession()
Client application calls this after any pre-session initialization (registering of Handlers, etc) Exceptions are raised for any failures. |
void |
pollUpdate()
client application calls this to force the Vorba client to check for updates immediately. |
void |
removeUpdateHandler(java.lang.Class rootObject)
|
void |
setUpdateHandler(IObjectUpdate handler)
Sets the update handler that will be called when any updates occur to objects of type rootObject. |
void |
storeDocument(java.io.File location)
Any application may call storeDocument to save a local copy of the current vamsas document including all application specific entries. |
void |
updateDocument(IClientDocument newdoc)
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 Validity of IClientDocument object instances after this call is implementation dependent TODO: consider refactoring to remove the redundant IClientDocument parameter for this method |
Method Detail |
public java.lang.String getAbout()
public java.lang.String getSessionUrn()
public SessionHandle getSessionHandle()
public ClientHandle getClientHandle()
public UserHandle getUserHandle()
public void finalizeClient()
public void addDocumentUpdateHandler(java.beans.PropertyChangeListener evt)
public IClientDocument getClientDocument() throws java.io.IOException
java.io.IOException
- if lock is not obtainable for the document in the sessionpublic void updateDocument(IClientDocument newdoc)
public void storeDocument(java.io.File location)
location
- to write zip filepublic void importDocument(java.io.File location)
location
- public void addVorbaEventHandler(java.lang.String EventChain, java.beans.PropertyChangeListener evt)
EventChain
- Name of event. Blank/null registers handler for all events.evt
- - event handler function.public void setUpdateHandler(IObjectUpdate handler)
handler
- public IObjectUpdate getUpdateHandler(java.lang.Class rootObject)
public void removeUpdateHandler(java.lang.Class rootObject)
public IObjectUpdate[] getUpdateHandlers()
public void pollUpdate()
public void joinSession() throws java.lang.Exception
java.lang.Exception
public IPickManager getPickManager()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |