/**
* Defines the API for the Vamsas XML Document
- * as accessed by a Vamsas Client Application.
+ * as accessed by a Vamsas SimpleClient Application.
* An instance of this interface is valid for a
* particular set of user, session and application
* handles.
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