X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Forg%2Fvamsas%2Fclient%2FIClientDocument.java;h=3c3aeff0c4f8ea1fc6354ed3be0ee7375bc88820;hb=4e2e8ec4215ad0f0864048e3eb44fdb7ec494e15;hp=c0887bce2f3c5a0b445885380cfd111e5568fb2f;hpb=acd34e614bdefb2eb49ff5a966a8c965d66b792a;p=vamsas.git

diff --git a/src/org/vamsas/client/IClientDocument.java b/src/org/vamsas/client/IClientDocument.java
index c0887bc..3c3aeff 100644
--- a/src/org/vamsas/client/IClientDocument.java
+++ b/src/org/vamsas/client/IClientDocument.java
@@ -47,25 +47,29 @@ public interface IClientDocument {
   object[] getObjects(VorbaId[] ids);
   /**
    * Returns all root objects in document. All objects inherit 
-   * from org.vamsas.client.object and have valid VorbaIds.
+   * from org.vamsas.client.object and have valid VorbaIds and provenance entries.
    * @return array of root Vamsas element objects. (TODO: insert correct class here)
    */
   object[] getVamsasRoots();
   /**
-   * Returns an object with a valid VorbaId so the 
-   * application may refer to it in its own dataspace.
+   * Returns an object 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.
    * @param unregistered unregistered vamsas object
    * @return VorbaId registered for vamsas object
    */
   VorbaId registerObject(object unregistered);
   /**
-   * Returns an array of objects, each with a valid VorbaId.
+   * Returns an array of objects, each with a valid VorbaId
+   * (and completed provenance entry).
    * Note: An object 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);
+  
   /**
    * Gets the application data associated with this session's
    * vamsas document that is accessible by the client