[Gnue-dev] Halloween 4: Appserver API

[Reinhard Mueller]

This is the proposed new API of Appserver against Forms, Reports, and
the Language Interface (what the Language Interface is will be explained
in the next mail).

Someone writing business rules will _not_ have to deal with this API.

These function calls will be passed over the choosen RPC interface,
which means that the actual definition syntax will depend on which
interface is used. For the general description of the API, we use C-like
syntax.

session_id open (auth_parameters param, ...);

void close (session_id sess, boolean commit);

void commit (session_id sess);

void rollback (session_id sess);

list_id request (session_id sess, string context, string conditions,
                 stringlist sort_order, stringlist properties);

int count (session_id sess, list_id list);

data fetch (session_id sess, list_id list, int start, int 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.

data load (session_id sess, object_id_list objectids,
           stringlist properties);

void store (session_id sess, object_id_list objectids,
            stringlist properties, data values);

string (?) call (session_id sess, object_id_list objectids,
                 string methodname, stringlist parameters);


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.

Still, more will follow...
-- 
Reinhard Mueller
GNU Enterprise project
http://www.gnue.org

signature.asc
Description: Dies ist ein digital signierter Nachrichtenteil