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

diff --git a/src/org/vamsas/client/IClientDocument.java b/src/org/vamsas/client/IClientDocument.java
index df20713..3c3aeff 100644
--- a/src/org/vamsas/client/IClientDocument.java
+++ b/src/org/vamsas/client/IClientDocument.java
@@ -6,7 +6,6 @@
  */
 package org.vamsas.client;
 
-import java.util.Vector;
 
 /**
  * Defines the API for the Vamsas XML Document 
@@ -48,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 registered vamsas object
+   * @return VorbaId registered for vamsas object
    */
-  object registerObject(object unregistered);
+  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 registered objects
+   * @return array of VorbaIds for the registered objects
    */
-  object[] registerObjects(object[] unregistered);
+  VorbaId[] registerObjects(object[] unregistered);
+  
   /**
    * Gets the application data associated with this session's
    * vamsas document that is accessible by the client