gnue/appserver/doc/api api.texi

[Jan Ischebeck]

CVSROOT:        /cvsroot/gnue
Module name:    gnue
Changes by:     Jan Ischebeck <address@hidden>  02/11/29 08:32:15

Modified files:
        appserver/doc/api: api.texi 

Log message:
        add RPC api section, but broke things because of bad texinfo skills ;)

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/appserver/doc/api/api.texi.diff?tr1=1.4&tr2=1.5&r1=text&r2=text

Patches:
Index: gnue/appserver/doc/api/api.texi
diff -c gnue/appserver/doc/api/api.texi:1.4 gnue/appserver/doc/api/api.texi:1.5
*** gnue/appserver/doc/api/api.texi:1.4 Thu Oct 24 15:56:58 2002
--- gnue/appserver/doc/api/api.texi     Fri Nov 29 08:32:15 2002
***************
*** 253,259 ****
  @end defmethod
  
  @c 
----------------------------------------------------------------------------
! @node AuthAgent,                                             FDL, Instance, 
Top
  @c 
----------------------------------------------------------------------------
  
  @chapter The AuthAgent Object
--- 253,259 ----
  @end defmethod
  
  @c 
----------------------------------------------------------------------------
! @node AuthAgent,                                         RPCapi, Instance, Top
  @c 
----------------------------------------------------------------------------
  
  @chapter The AuthAgent Object
***************
*** 268,273 ****
--- 268,344 ----
  @defmethod AuthAgent hasAccess (@var{session}, @var{user}, @var{classname})
  Return information if the user @var{user} has access to @var{classname}.
  @end defmethod
+ 
+ @c 
----------------------------------------------------------------------------
+ @node RPCapi,                                             FDL, AuthAgent, Top
+ @c 
----------------------------------------------------------------------------
+ 
+ @chapter The RPC API
+ 
+ @section Basic Operations
+ 
+ @defmethod AuthAgent authentificate (@var{session}, @var{user}, @var{auth})
+ Authentificate the user @var{user} with the informations stored in the
+ @var{auth} dictionary.  The function returns 'true' on success.
+ @end defmethod
+ 
+ @defmethod AuthAgent hasAccess (@var{session}, @var{user}, @var{classname})
+ Return information if the user @var{user} has access to @var{classname}.
+ @end defmethod
+ 
+ 
+ @defmethod session_id open (@var{auth_parameters})
+ @end defmethod
+ 
+ @defmethod void close (@var{session_id},@var{commit})
+ @end defmethod
+ 
+ @defmethod  void commit (@var{session_id})
+ 
+ @end defmethod
+ 
+ @defmethod void rollback (@var{session_id})
+ 
+ @end defmethod
+ 
+ @defmethod list_id request 
(@var{session_id},@var{context},@var{conditions},@var{sort_order},@var{properties})
+ 
+ @end defmethod
+ 
+ @defmethod int count (@var{session_id},@var{list_id})
+ 
+ @end defmethod
+ 
+ @defmethod data fetch 
(@var{session_id},@var{list_id},@var{start},@var{count});
+ returns a 2-dimensional array of data with count rows, where column 0
+ always holds the object_id of the object.
+ Negative values for start indicate position from the end of the list.
+ @end defmethod
+ 
+ @defmethod data load (@var{session_id}, 
@var{object_id_list},@var{properties});
+ 
+ @end defmethod
+ 
+ @defmethod void store (@var{session_id}, 
@var{object_id_list},@var{properties},@var{values})
+ 
+ @end defmethod
+ 
+ @defmethod string (?) call (@var{session_id}, 
@var{object_id_list},@var{methodname}, @var{parameters})
+ @end defmethod
+ 
+ 
+ An object_id holds enough information for Appserver to identify the
+ object. For example, the object_id could be built from the fully
+ qualified class name and the (anonymous) primary key, like
+ "base_customer.4711081512345678"
+ 
+ The "request" and "fetch" functions are used to get data from the
+ appserver for objects that fulfill a specific condition, while the
+ "load" function is used to request properties of an object with an
+ already known object id.
+ 
+ Properties that hold a reference to another object return the object_id
+ in this interface.
  
  @raisesections