|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Defines the API for the Vamsas XML Document as accessed by a Vamsas SimpleClient Application. An instance of this interface is valid for a particular set of user, session and application handles. 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 Vobject references, These are guaranteed to be unique amongst existing objects in the document, all other references created by this Vobject's instance and all other references constructed by any other vamsas agents in the session. 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 control based on user identity. A user may also want to make private notes, not available to other people using the same application in the same session. TODO: LATER: implement a more sophisticated query interface for quickly identifying new data in a vamsas document and manipulating existing objects
Method Summary | |
void |
addVamsasRoot(VAMSAS newroot)
Adds a new VAMSAS root entry TODO: decide on same InvalidVamsasObject exceptions. |
IClientAppdata |
getClientAppdata()
Get instance of Client and User specific vamsas document data access interface. |
Vobject |
getObject(VorbaId id)
Get a single Vobject. |
Vobject[] |
getObjects(VorbaId[] ids)
Get a list of objects. |
VAMSAS[] |
getVamsasRoots()
Returns all root objects in document. |
VorbaId |
registerObject(Vobject unregistered)
Returns an Vobject with a valid VorbaId, and provenance element. |
VorbaId[] |
registerObjects(Vobject[] unregistered)
Returns an array of objects, each with a valid VorbaId (and completed provenance entry). |
void |
setVamsasRoots(VAMSAS[] roots)
set the VAMSAS roots in the document TODO: decide if objects are verified for provenance and VorbaIds by this call or when document is stored TODO: decide if this call should throw InvalidVamsasObject exceptions. |
Method Detail |
public Vobject getObject(VorbaId id)
id
-
public Vobject[] getObjects(VorbaId[] ids)
ids
-
public VAMSAS[] getVamsasRoots()
public void setVamsasRoots(VAMSAS[] roots)
roots
- public void addVamsasRoot(VAMSAS newroot)
newroot
- public VorbaId registerObject(Vobject unregistered)
unregistered
- unregistered vamsas Vobject
public VorbaId[] registerObjects(Vobject[] unregistered)
unregistered
- array of unregistered objects.
public IClientAppdata getClientAppdata()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |