uk.ac.vamsas.objects
Interface IVorbaBinding


public interface IVorbaBinding

Provides methods to map between VorbaIds and arbitrary object references for use by a vamsas Application when moving between its own datamodel and the Vamsas session objects. The implementing class needs a valid client-document instance if it is expected to be able to register newly created vObjects. Normally this will be the case if 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

Method Summary
 void bindAppsObjectToVamsasObject(java.lang.Object appObject, Vobject vObject)
          Record a mapping between a vamsas document object and an application's internal object.
 java.lang.Object getAppsObjectFor(Vobject vObject)
          Get the Application's own object bound to an existing Vamsas session object
 Vobject getVamsasObjectFor(java.lang.Object appObject)
          get the Vamsas session object bound to an internal object.
 

Method Detail

getVamsasObjectFor

public Vobject getVamsasObjectFor(java.lang.Object appObject)
get the Vamsas session object bound to an internal object.

Parameters:
appObject -
Returns:
valid session object or Null.

getAppsObjectFor

public java.lang.Object getAppsObjectFor(Vobject vObject)
Get the Application's own object bound to an existing Vamsas session object

Parameters:
vObject - - object in vamsas document
Returns:
apps object bound to the vamsas document object

bindAppsObjectToVamsasObject

public void bindAppsObjectToVamsasObject(java.lang.Object appObject,
                                         Vobject vObject)
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

Parameters:
appObject -
vObject - - if newly created then it will be registered using the uk.ac.vamsas.client.IClientDocument.registerObject method.