added comments concerning provenance

git-svn-id: https://svn.lifesci.dundee.ac.uk/svn/repository/trunk@14 be28352e-c001-0410-b1a7-c7978e42abec

diff --git a/src/org/vamsas/client/IClient.java b/src/org/vamsas/client/IClient.java
index ae7f175..dc1d577 100644 (file)
--- a/src/org/vamsas/client/IClient.java
+++ b/src/org/vamsas/client/IClient.java
@@ -75,6 +75,9 @@ public interface IClient {
      * Queue new Vorba objects for storage and propagation 
      * to other clients (via Event.DOCUMENT_UPDATE based 
      * notification of document change)
+     * New objects without provenance information will be 
+     * given a default entry using the IClient's application, 
+     * user (and session) handles
      */
     public void updateDocument(IClientDocument newdoc);
     /**

diff --git a/src/org/vamsas/client/IClientDocument.java b/src/org/vamsas/client/IClientDocument.java
index c0887bc..3c3aeff 100644 (file)
--- 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