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

[Reinhard Mueller]

CVSROOT:        /cvsroot/gnue
Module name:    gnue
Changes by:     Reinhard Mueller <address@hidden>       02/05/26 16:46:25

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

Log message:
        Updated API documentation.

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

Patches:
Index: gnue/appserver/doc/api/api.texi
diff -c gnue/appserver/doc/api/api.texi:1.1 gnue/appserver/doc/api/api.texi:1.2
*** gnue/appserver/doc/api/api.texi:1.1 Tue May  7 03:47:08 2002
--- gnue/appserver/doc/api/api.texi     Sun May 26 16:46:25 2002
***************
*** 100,105 ****
--- 100,119 ----
  @code{FALSE} otherwise.
  @end defivar
  
+ @section Retrieving Lists Of Business Objects
+ 
+ To retrieve a list of business objects of a given class, first a
+ @code{geasList} object has to be created. This is, initially, an empty
+ list that can later be filled with instances of the given class.
+ 
+ To populate the list with real instances, use the population methods of the
+ @code{geasList} object.
+ 
+ @defmethod geasSession createList (@var{class})
+ Creates an empty list that can hold @code{geasInstance}) objects of the
+ given class.
+ @end defmethod
+ 
  @section Transactions
  
  Transactions take place at the session level. All operations that are 
performed
***************
*** 119,147 ****
  @defmethod geasSession rollback
  @end defmethod
  
- @section Creating New Business Object Instances
- 
- @defmethod geasSession createInstance (@var{class})
- Creates a new instance of a business object of the given class. Returns a
- @code{geasInstance} object that represents the newly created business object.
- This business object can be regarded persistent as soon as the current
- transaction is committed.
- @end defmethod
- 
- @section Retrieving Lists Of Business Objects
- 
- To retrieve a list of business objects of a given class, first a
- @code{geasList} object has to be created. This is, initially, an empty
- list that can later be filled with instances of the given class.
- 
- To populate the list with real instances, use the population methods of the
- @code{geasList} object.
- 
- @defmethod geasSession createList (@var{class})
- Creates an empty list that can hold @code{geasInstance}) objects of the
- given class.
- @end defmethod
- 
  @c 
----------------------------------------------------------------------------
  @node List,                                              Instance, Session, 
Top
  @c 
----------------------------------------------------------------------------
--- 133,138 ----
***************
*** 197,202 ****
--- 188,202 ----
  Returns the next @code{geasInstance} of the list.
  @end defmethod
  
+ @section Creating New Business Object Instances
+ 
+ @defmethod geasList insertNewInstance (@var{class})
+ Creates a new instance of a business object of the given class. Returns a
+ @code{geasInstance} object that represents the newly created business object.
+ This business object can be regarded persistent as soon as the current
+ transaction is committed.
+ @end defmethod
+ 
  @c 
----------------------------------------------------------------------------
  @node Instance,                                                  FDL, List, 
Top
  @c 
----------------------------------------------------------------------------
***************
*** 211,217 ****
  depending on the type of the field.
  @end defmethod
  
! @defmethod geasInstance set (@var{fieldname}, @var{value})
  Sets the given field of the business object to @var{value}. The datatype of
  @var{value} must be compatible with the type of the field, otherwise an
  exception will be raised.
--- 211,217 ----
  depending on the type of the field.
  @end defmethod
  
! @defmethod geasInstance put (@var{fieldname}, @var{value})
  Sets the given field of the business object to @var{value}. The datatype of
  @var{value} must be compatible with the type of the field, otherwise an
  exception will be raised.
***************
*** 219,224 ****
--- 219,231 ----
  
  @defmethod geasInstance call (@var{methodname})
  Calls a method of the business object.
+ @end defmethod
+ 
+ @section Deleting Objects
+ 
+ @defmethod geasInstance delete
+ Deletes the business object. The business object is not longer persistent
+ after the next commit.
  @end defmethod
  
  @raisesections
Index: gnue/appserver/doc/api/version.texi
diff -c gnue/appserver/doc/api/version.texi:1.1 
gnue/appserver/doc/api/version.texi:1.2
*** gnue/appserver/doc/api/version.texi:1.1     Tue May  7 03:47:08 2002
--- gnue/appserver/doc/api/version.texi Sun May 26 16:46:25 2002
***************
*** 1,2 ****
! @set UPDATED 2002-05-01
! @set EDITION 0.0.3
--- 1,2 ----
! @set UPDATED 2002-05-26
! @set EDITION 0.0.4