gnue/appserver/doc/api api.texi version.texi

[Reinhard Mueller]

CVSROOT:        /cvsroot/gnue
Module name:    gnue
Changes by:     Reinhard Mueller <address@hidden>       02/12/20 15:33:26

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

Log message:
        Fixed typo, changed "store" to return a stringlist, defined all function
        calls atomic in case of an exception.

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

Patches:
Index: gnue/appserver/doc/api/api.texi
diff -c gnue/appserver/doc/api/api.texi:1.7 gnue/appserver/doc/api/api.texi:1.8
*** gnue/appserver/doc/api/api.texi:1.7 Sun Dec  8 13:47:57 2002
--- gnue/appserver/doc/api/api.texi     Fri Dec 20 15:33:26 2002
***************
*** 81,87 ****
  
  @deftp {Data Type} string
  This is a data type that must be able to hold variable lenght strings
! without lenth limitations.
  @end deftp
  
  @deftp {Data Type} stringlist
--- 81,87 ----
  
  @deftp {Data Type} string
  This is a data type that must be able to hold variable lenght strings
! without length limitations.
  @end deftp
  
  @deftp {Data Type} stringlist
***************
*** 111,116 ****
--- 111,121 ----
  
  @chapter API Functions
  
+ All API functions can raise exceptions on failure.  All functions are
+ atomic, in the sense that in case of an exception the function has no
+ effect at all.  No error in a function call can cause a function to
+ be "half-done".
+ 
  The exact syntax of the API functions is dependant on the selected
  RPC interface and the language sitting on top of it.  However, we
  are describing the functions in a C-like syntax here, using the data
***************
*** 205,211 ****
  the object_ids in column 0.
  @end deftypefun
  
! @deftypefun void store (session_id @var{session}, string @var{classname}, 
stringlist @var{object_ids}, stringlist @var{properties}, stringtable 
@var{values})
  Stores the data in @var{values} in the objects identified by @var{object_ids}.
  Every row in @var{values} matches an entry in @var{object_ids}, while every
  column matches an entry in @var{properties}.
--- 210,216 ----
  the object_ids in column 0.
  @end deftypefun
  
! @deftypefun stringlist store (session_id @var{session}, string 
@var{classname}, stringlist @var{object_ids}, stringlist @var{properties}, 
stringtable @var{values})
  Stores the data in @var{values} in the objects identified by @var{object_ids}.
  Every row in @var{values} matches an entry in @var{object_ids}, while every
  column matches an entry in @var{properties}.
***************
*** 213,218 ****
--- 218,226 ----
  Validation is performed before the actual storing is done. If validation
  of a single object fails, none of the objects are stored, but an exception
  is raised.
+ This function returns a list of all object ids of the stored objects.  This
+ is important for the caller to know under which object ids the new objects
+ have been stored and can be accessed from now on.
  Note that after calling @code{store}, @code{commit} has to be called to make
  the changes persistent, while a call to @code{rollback} can undo the changes.
  @end deftypefun
Index: gnue/appserver/doc/api/version.texi
diff -c gnue/appserver/doc/api/version.texi:1.5 
gnue/appserver/doc/api/version.texi:1.6
*** gnue/appserver/doc/api/version.texi:1.5     Sun Dec  8 13:47:57 2002
--- gnue/appserver/doc/api/version.texi Fri Dec 20 15:33:26 2002
***************
*** 1,2 ****
! @set UPDATED 2002-12-08
! @set EDITION 0.0.6
--- 1,2 ----
! @set UPDATED 2002-12-20
! @set EDITION 0.0.7