refactored org to uk

[vamsas.git] / src / org / vamsas / client / IClientDocument.java

diff --git a/src/org/vamsas/client/IClientDocument.java b/src/org/vamsas/client/IClientDocument.java
index 84149b6..8db697f 100644 (file)
--- a/src/org/vamsas/client/IClientDocument.java
+++ b/src/org/vamsas/client/IClientDocument.java
@@ -19,12 +19,11 @@ import org.vamsas.objects.core.VAMSAS;
  * It initially represents a snapshot of the 
  * XML document at a particular time - queriable by 
  * reference or by retrieval of root objects.
- * It provides methods to make new object references, 
+ * It provides methods to make new Vobject references, 
  * These are guaranteed to be unique amongst existing 
  * objects in the document, all other references created 
- * by this object's instance and all other references 
+ * by this Vobject's instance and all other references 
  * constructed by any other vamsas agents in the session.
- * TODO: NOW! make AppData interface instance for getting/setting 'global' appData and the current users' appData entry.   
  * TODO: LATER: finegrained access control for public/private user access
  * Finegrained access control: Since a clientDocument is created for a particular 
  * UserHandle, there is scope for fine grain data access 
@@ -38,20 +37,20 @@ import org.vamsas.objects.core.VAMSAS;
 public interface IClientDocument {
   
   /**
-   * Get a single object.
+   * Get a single Vobject.
    * @param id
-   * @return object referred to by id or null if it doesn't exist.
+   * @return Vobject referred to by id or null if it doesn't exist.
    */
-  object getObject(VorbaId id);
+  Vobject getObject(VorbaId id);
   /**
    * Get a list of objects.
    * @param ids
    * @return array of objects using a vector of VorbaId ids.
    */
-  object[] getObjects(VorbaId[] ids);
+  Vobject[] getObjects(VorbaId[] ids);
   /**
    * Returns all root objects in document. All objects inherit 
-   * from org.vamsas.client.object and have valid VorbaIds and provenance entries.
+   * from org.vamsas.client.Vobject and have valid VorbaIds and provenance entries.
    * @return array of root Vamsas element objects.
    */
   VAMSAS[] getVamsasRoots();
@@ -71,27 +70,27 @@ public interface IClientDocument {
    */
   void addVamsasRoot(VAMSAS newroot);
   /**
-   * Returns an object with a valid VorbaId, and provenance element. 
+   * Returns an Vobject with a valid VorbaId, and provenance element. 
    * The VorbaId is so the application may refer to it in 
    * its own dataspace.
    * 
-   * Note: An object with valid VorbaId will not be reregistered.
-   * Advice: Calling this method for a high-level object 
+   * Note: An Vobject with valid VorbaId will not be reregistered.
+   * Advice: Calling this method for a high-level Vobject 
    * (such as org.vamsas.objects.core.VAMSAS) will 
    * register all its component objects too.
    * 
-   * @param unregistered unregistered vamsas object
-   * @return VorbaId registered for vamsas object
+   * @param unregistered unregistered vamsas Vobject
+   * @return VorbaId registered for vamsas Vobject
    */
-  VorbaId registerObject(object unregistered);
+  VorbaId registerObject(Vobject unregistered);
   /**
    * Returns an array of objects, each with a valid VorbaId
    * (and completed provenance entry).
-   * Note: An object with valid VorbaId will not be reregistered.
+   * Note: An Vobject with valid VorbaId will not be reregistered.
    * @param unregistered array of unregistered objects.
    * @return array of VorbaIds for the registered objects
    */
-  VorbaId[] registerObjects(object[] unregistered);
+  VorbaId[] registerObjects(Vobject[] unregistered);
   /**
    * Get instance of Client and User specific vamsas document data access interface.
    * @return Interface to Client and user specific application data