added usage notes about removing specific object bindings

[vamsas.git] / src / uk / ac / vamsas / objects / IVorbaBinding.java

diff --git a/src/uk/ac/vamsas/objects/IVorbaBinding.java b/src/uk/ac/vamsas/objects/IVorbaBinding.java
index 9b62052..f70a3dd 100644 (file)
--- a/src/uk/ac/vamsas/objects/IVorbaBinding.java
+++ b/src/uk/ac/vamsas/objects/IVorbaBinding.java
@@ -15,7 +15,10 @@ import uk.ac.vamsas.client.VorbaId;
  * the implementing class has been generated by an IClient implementation which will\r
  * also have passed it a reference to the current valid IClientDocument instance for\r
  * that application's document access thread. \r
+ * TODO: add remove/clear binding functions - currently you can just pass a null\r
+ * to either argument for bindAppsObjectToVamsasObject to remove the binding from memory. \r
  * @author JimP\r
+ * \r
  */\r
 public interface IVorbaBinding {\r
 /**\r
@@ -33,8 +36,10 @@ public interface IVorbaBinding {
 \r
   /**\r
    * Record a mapping between a vamsas document object and an application's internal object.\r
+   * If either appObject or vObject parameters are null then any existing \r
+   * binding to the non-null object will be deleted\r
    * @param appObject\r
-   * @param vObject - this must have been \r
+   * @param vObject - if newly created then it will be registered using the uk.ac.vamsas.client.IClientDocument.registerObject method.\r
    */\r
   void bindAppsObjectToVamsasObject(Object appObject, uk.ac.vamsas.client.Vobject vObject);\r
 }\r