uk.ac.vamsas.client
Interface IVorbaIdFactory

All Known Implementing Classes:
VorbaIdFactory

public interface IVorbaIdFactory

Author:
jimp middleware interface for generating new VorbaId objects for a particular vamsas client based on the current session, user and client handle. Generally implemented by instances of the vamsas library api only.

Method Summary
 ClientHandle getClientHandle()
           
 SessionHandle getSessionHandle()
           
 UserHandle getUserHandle()
           
 VorbaId makeVorbaId(Vobject vobject)
          construct a new id appropriate for this client in the vamsas session.
 void updateHashValue(Vobject vobject)
          called when an object is touched by the vamsas library prior to writing to record last hash for the object's VorbaId
 

Method Detail

makeVorbaId

public VorbaId makeVorbaId(Vobject vobject)
construct a new id appropriate for this client in the vamsas session.

Parameters:
vobject - TODO
Returns:
valid VorbaId for session, or null if VorbaIdFactory not configured correctly.

getSessionHandle

public SessionHandle getSessionHandle()

getClientHandle

public ClientHandle getClientHandle()

getUserHandle

public UserHandle getUserHandle()

updateHashValue

public void updateHashValue(Vobject vobject)
called when an object is touched by the vamsas library prior to writing to record last hash for the object's VorbaId

Parameters:
vobject -