coliver 2003/03/05 20:17:16
Modified: src/idl/cocoon cocoon.idl
src/idl/cocoon_flow cocoon_flow.idl
Log:
added additional docs
Revision Changes Path
1.2 +4 -0 xml-cocoon2/src/idl/cocoon/cocoon.idl
Index: cocoon.idl
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/idl/cocoon/cocoon.idl,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- cocoon.idl 6 Mar 2003 03:44:49 -0000 1.1
+++ cocoon.idl 6 Mar 2003 04:17:16 -0000 1.2
@@ -37,4 +37,8 @@
typedef Object RowsByIndex[ROWCOUNT][COLUMNCOUNT];
interface XForm;
typedef sequence<XForm> XForms;
+ interface Iterator {
+ };
+ interface Continuation {
+ };
};
1.2 +35 -5 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.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- cocoon_flow.idl 6 Mar 2003 03:44:49 -0000 1.1
+++ cocoon_flow.idl 6 Mar 2003 04:17:16 -0000 1.2
@@ -61,15 +61,36 @@
*/
module cocoon_flow {
-
+
/**
- * Interface to a Continuation
+ * Representation of continuations in a Web environment.
+ *
+ * <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.
+ *
+ * <p>If there is no parent <code>WebContinuation</code>, the created
+ * continuation becomes the root of a tree of
+ * <code>WebContinuation</code>s.
*/
-
interface WebContinuation {
+ /**
+ * Unguessable unique identifier of this object
+ */
readonly attribute string id;
- readonly attribute Object continuation;
+ /**
+ * Current continuation
+ */
+ readonly attribute Continuation continuation;
+ /**
+ * Deletes this continuation together with all of its children
+ */
void invalidate();
+ /**
+ * Debugging aid that displays the tree of continuations rooted
+ * in this object
+ */
void display();
};
@@ -126,8 +147,9 @@
* @param uri the relative URL of the page to be sent back to the client
* @param bean a context object which can be accessed inside this page to
extract various values and place them in the generated page
* @param timeToLive time to live for the continuation created
+ * @return the continuation
*/
- void sendPageAndWait(in string uri, in Object bean, in long timeToLive);
+ WebContinuation sendPageAndWait(in string uri, in Object bean, in long
timeToLive);
/**
* Action Support
@@ -273,6 +295,14 @@
* @return result of computing <code>expr</code>
*/
Object getValue(in string expr);
+
+ /**
+ * Returns an iterator over a nodeset value of an xpath expression
+ * evaluated against the model of this form
+ * @param expr xpath expression
+ * @return java.util.Iterator representing a nodeset
+ */
+ cocoon::Iterator iterate(in string expr);
/**
* Sends view to presentation pipeline and waits for subsequent submission.
