X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Forg%2Fvamsas%2Fclient%2FIClient.java;h=51367c97681d6862bf82f75c3bba7cd4f51f2451;hb=bca394759623e8a1e594a55f25b38b532c3c8337;hp=a8d122e2da0797f91e917fce93238687e0108b2a;hpb=43ba16c5dc20e182c8d48db1f32962bad747f999;p=vamsas.git diff --git a/src/org/vamsas/client/IClient.java b/src/org/vamsas/client/IClient.java index a8d122e..51367c9 100644 --- a/src/org/vamsas/client/IClient.java +++ b/src/org/vamsas/client/IClient.java @@ -13,8 +13,8 @@ import java.io.IOException; * created by an IClientFactory instance for a particular session, * user, and application handle. * (it's VORBA, not CORBA!) - * TODO: add exceptions for timeouts raised when there are problems accessing session data (because another application is hogging it). - * TODO: 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) + * 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) */ public interface IClient { @@ -22,9 +22,9 @@ public interface IClient { /** * Self-documenting/describing info for the application to present * to the user. - * TODO: formalise this for describing VAMSAS system, a particular + * LATER: formalise this for describing VAMSAS system, a particular * Vorba client agent, and a particular session. - * @returns string like VamsasClient v.1.1.1 (GPL) and whatever + * @return string like VamsasClient v.1.1.1 (GPL) and whatever */ public String getAbout(); @@ -61,7 +61,7 @@ public interface IClient { * 'RequestToCloseDocument' events from the Vorba * agent in the latter case and so prompt the user * to save the session locally. - * TODO: pick a better name ? + * LATER: pick a better name ? */ public void finalizeClient(); /** @@ -97,7 +97,7 @@ public interface IClient { * Any application may call importDocument to merge a stored * vamsasDocument into the current session. * Note: use a IClientFactory's implementation to make sessions out of vamsas documnts - * TODO: LATER: VAMSAS: The IClient implementation will handle all ID 'relocations' + * LATER: VAMSAS: The IClient implementation will handle all ID 'relocations' * @param location */ public void importDocument(java.io.File location); @@ -107,7 +107,7 @@ public interface IClient { * 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. + * LATER: 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. */ @@ -125,7 +125,7 @@ public interface IClient { * 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) + * LATER: create VAMSAS exception hierarchy (in a language agnostic manner) */ public void joinSession() throws Exception; }