coliver 2003/03/05 20:58:26
Modified: src/idl/cocoon_flow cocoon_flow.idl Log: added more missing docs Revision Changes Path 1.3 +73 -18 xml-cocoon2/src/idl/cocoon_flow/cocoon_flow.idl Index: cocoon_flow.idl =================================================================== RCS file: /home/cvs/xml-cocoon2/src/idl/cocoon_flow/cocoon_flow.idl,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- cocoon_flow.idl 6 Mar 2003 04:17:16 -0000 1.2 +++ cocoon_flow.idl 6 Mar 2003 04:58:25 -0000 1.3 @@ -1,3 +1,6 @@ +#include "cocoon/cocoon.idl" + +// Taken from http://www.webweavertech.com/ovidiu/weblog/archives/000042.html /** * <p>The general flow of actions in an application which uses the control flow is as described below.</p> * @@ -68,11 +71,11 @@ * <p>Because a user may click on the back button of the browser and * restart a saved computation in a continuation, each * <code>WebContinuation</code> becomes the parent of a subtree of - * continuations. + * continuations.</p> * * <p>If there is no parent <code>WebContinuation</code>, the created * continuation becomes the root of a tree of - * <code>WebContinuation</code>s. + * <code>WebContinuation</code>s.</p> */ interface WebContinuation { /** @@ -82,7 +85,7 @@ /** * Current continuation */ - readonly attribute Continuation continuation; + readonly attribute cocoon::Continuation continuation; /** * Deletes this continuation together with all of its children */ @@ -124,7 +127,10 @@ * Top level object */ interface Global { - + + /** + * Reference to the logging facility + */ readonly attribute Log log; /** @@ -151,32 +157,40 @@ */ WebContinuation sendPageAndWait(in string uri, in Object bean, in long timeToLive); + // Action Support + /** - * Action Support - * - * call an action from JS + * Call an action from JS */ void act(in string type, in string source, in Object parameters); + // InputModule Support + /** - * InputModule Support - * - * obtain value form InputModule + * Obtain value from InputModule + * @param type + * @param attribute_ */ Object inputValue(in string type, in string attribute_); + // OutputModule Support + /** - * OutputModule Support - * set an attribute (starts transaction, commit or rollback required!) + * Set an attribute (starts transaction, commit or rollback required!) + * @param type (not sure) + * @param attribute_ (not sure) + * @param value (not sure) */ void outputSet(in string type, in string attribute_, in Object value); /** - * makes attributes permanent (ends transaction) + * Makes attributes permanent (ends transaction) + * @param type (not sure) */ void outputCommit(in string type); /** - * deletes attributes (ends transaction) + * Deletes attributes (ends transaction) + * @param type (not sure) */ void outputRollback(in string type); @@ -236,16 +250,52 @@ void removeSession(); - void forwardTo(in string uri, in Object bizData, in Object continuation); + /** + * Forward the request to a Cocoon pipeline. + * + * @param URI a <code>String</code>, the URI of the forwarded request + * @param bizData an <code>Object</code>, the business data object + * to be made available to the forwarded pipeline + * @param continuation a <code>WebContinuation</code>, the + * continuation to be called to resume the processing + */ + void forwardTo(in string uri, in Object bizData, in WebContinuation continuation); + /** + * Dump to Log file all <code>WebContinuation</code>s + * in the system + */ void displayAllContinuations(); + /** + * Call an action from JS + */ void callAction(in string type, in string source, in Object parameters); + /** + * Obtain value form InputModule + * @param type (not sure) + * @param attribute_ (not sure) + */ Object inputModuleGetAttribute(in string type, in string attribute_); + /** + * Set an attribute (starts transaction, commit or rollback required!) + * @param type (not sure) + * @param attribute_ (not sure) + * @param value (not sure) + */ void outputModuleSetAttribute(in string type, in string attribute_, in Object value); + /** + * Makes attributes permanent (ends transaction) + * @param type (not sure) + */ void outputModuleCommit(in string type); + + /** + * Deletes attributes (ends transaction) + * @param type (not sure) + */ void outputModuleRollback(in string type); }; @@ -266,10 +316,13 @@ */ cocoon::XForm constructor(in string form_id, in string validator_namespace, in string validator_document); + /** + * Global variable that stores XForm instances by id + */ readonly attribute cocoon::XForms forms; /** - * The model object of this form: any Any Java bean, JavaScript, DOM, or JDOM object + * The model object of this form: any Java bean, JavaScript, DOM, or JDOM object */ readonly attribute Object model; @@ -353,18 +406,20 @@ */ readonly attribute boolean isLimitedByMaxRows; }; - + /** * High level interface to JDBC operations modeled after JSTL */ interface Database { + /** * Used to execute INSERT, UPDATE, and DELETE statements, as well as statements that create or remove database objects, such as CREATE TABLE and DROP TABLE. It returns the number of rows affected by the statement. * @param sql SQL statement to execute * @return the number of rows affected */ - long update(in string sql); + long update(in string sql, in long startRow, in long maxRows); + /** * Executes a SQL SELECT statement. You can limit the result with startRow and maxRows (which are optional). * @param sql SQL statement to execute
