uk.ac.vamsas.client
Interface IObjectUpdate

public interface IObjectUpdate

Methods implemented by a Vamsas Application's Object Update handler

Author:

vamsas Introduced November 2006 Vamsas Meeting TODO: verify this is sufficient for the per-object update event mechanism

Method Summary

java.lang.Class	getRootVobject() Called by the library to find out which vamsas document object this update handler is interested in
boolean	handlesSubtreeUpdates() Called to test if this handler is to be called for updates to any Vobjects below the Root Vobject in the vamsas document.
void	update(Vobject updated, IClientDocument cdoc) Method called by Vamsas Client Library for all updated objects that the handler is registered for.

Method Detail

getRootVobject

public java.lang.Class getRootVobject()

Called by the library to find out which vamsas document object this update handler is interested in

Returns:

class that extends org.vamsas.Vobject

handlesSubtreeUpdates

public boolean handlesSubtreeUpdates()

Called to test if this handler is to be called for updates to any Vobjects below the Root Vobject in the vamsas document.

Returns:

false means IObjectUpdate.update(updated, cdoc) will only be called with instances of type getRootVobject().

update

public void update(Vobject updated,
                   IClientDocument cdoc)

Method called by Vamsas Client Library for all updated objects that the handler is registered for.

Parameters:

updated -

cdoc -