From ae57d8e5553836656849b055fb138ce588ef8998 Mon Sep 17 00:00:00 2001 From: jprocter Date: Fri, 15 Dec 2006 11:10:55 +0000 Subject: [PATCH] added usage notes about removing specific object bindings git-svn-id: https://svn.lifesci.dundee.ac.uk/svn/repository/trunk@311 be28352e-c001-0410-b1a7-c7978e42abec --- src/uk/ac/vamsas/objects/IVorbaBinding.java | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/uk/ac/vamsas/objects/IVorbaBinding.java b/src/uk/ac/vamsas/objects/IVorbaBinding.java index 9b62052..f70a3dd 100644 --- 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 * also have passed it a reference to the current valid IClientDocument instance for * that application's document access thread. + * TODO: add remove/clear binding functions - currently you can just pass a null + * to either argument for bindAppsObjectToVamsasObject to remove the binding from memory. * @author JimP + * */ public interface IVorbaBinding { /** @@ -33,8 +36,10 @@ public interface IVorbaBinding { /** * Record a mapping between a vamsas document object and an application's internal object. + * If either appObject or vObject parameters are null then any existing + * binding to the non-null object will be deleted * @param appObject - * @param vObject - this must have been + * @param vObject - if newly created then it will be registered using the uk.ac.vamsas.client.IClientDocument.registerObject method. */ void bindAppsObjectToVamsasObject(Object appObject, uk.ac.vamsas.client.Vobject vObject); } -- 1.7.10.2