You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by co...@apache.org on 2003/05/24 22:14:33 UTC
cvs commit: cocoon-2.1/src/documentation/xdocs/userdocs/flow api.xml
coliver 2003/05/24 13:14:33
Modified: src/documentation/xdocs/userdocs/flow api.xml
Log:
document WebContinuation
Revision Changes Path
1.2 +38 -12 cocoon-2.1/src/documentation/xdocs/userdocs/flow/api.xml
Index: api.xml
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/flow/api.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- api.xml 24 May 2003 18:51:26 -0000 1.1
+++ api.xml 24 May 2003 20:14:33 -0000 1.2
@@ -36,7 +36,7 @@
<p>
Passes control to the Cocoon sitemap to generate the output page.
</p>
- <p>The flow script is suspended after the page is generated and the whole execution stack saved in a the WebContinuation object returned from this function. </p>
+ <p>The flow script is suspended after the page is generated and the whole execution stack saved in the WebContinuation object returned from this function. </p>
<p> <code>uri</code> is the relative URL of the page to be sent back to the client. <code>bean</code> is a context object which can be accessed inside this page to extract various values and place them in the generated page.</p>
<p><code>timeToLive</code> is the time to live for the continuation created.</p>
<p>The return value is the continuation object.</p>
@@ -48,35 +48,35 @@
<p>The <code>cocoon</code> object represents the current Cocoon sitemap and provides the following readonly properties:</p>
<p>The current Cocoon request:</p>
<p>
- <code>[org.apache.cocoon.environment.Request] request</code>
+ Property <code>[org.apache.cocoon.environment.Request] request</code>
</p>
<p>The current Cocoon response:</p>
<p>
- <code>[org.apache.cocoon.environment.Response] response</code>
+ Property <code>[org.apache.cocoon.environment.Response] response</code>
</p>
<p>The current Cocoon session:</p>
<p>
- <code>[org.apache.cocoon.environment.Session] session</code>
+ Property <code>[org.apache.cocoon.environment.Session] session</code>
</p>
<p>The current Cocoon application context:</p>
<p>
- <code>[org.apache.cocoon.environment.Context] context</code>
+ Property <code>[org.apache.cocoon.environment.Context] context</code>
</p>
<p>The current Cocoon environment:</p>
<p>
- <code>[org.apache.cocoon.environment.Environment] environment</code>
+ Property <code>[org.apache.cocoon.environment.Environment] environment</code>
</p>
<p>The current Sitemap's component manager:</p>
<p>
- <code>[org.apache.avalon.framework.component.ComponentManager] componentManager</code>
+ Property <code>[org.apache.avalon.framework.component.ComponentManager] componentManager</code>
</p>
<p>Any parameters passed to the script by the Sitemap:</p>
<p>
- <code>[Array] parameters</code>
+ Property <code>[Array] parameters</code>
</p>
<p>The <code>cocoon</code> object also provides the following functions:</p>
<p>
- <code>[Boolean] process([String] uri, [Object] bizData, [java.io.OutputStream] stream)</code></p>
+ Function <code>[Boolean] process([String] uri, [Object] bizData, [java.io.OutputStream] stream)</code></p>
<p>
Call the Cocoon sitemap for the given URI, sending the output of the
eventually matched pipeline to the specified outputstream.</p>
@@ -87,7 +87,7 @@
<p>Returns the result from the Cocoon processor.
</p>
- <p><code>void createSession()</code></p>
+ <p> Function <code>createSession()</code></p>
<p>
Associate the current set of JavaScript global variables with the user's session. This means that all invocations from the
sitemap of a JavaScript function (using the <map:call
@@ -95,18 +95,44 @@
</p>
<p>
- <code>void removeSession()</code>
+ Function <code>removeSession()</code>
</p>
<p>
Dissociate global JavaScript variables from the user's session.
</p>
- <p><code>void load([String] uri)</code></p>
+ <p>Function <code>load([String] uri)</code></p>
<p>
Load the JavaScript script specified by <code>uri</code>. The Cocoon
source resolver is used to resolve <code>uri</code>.
</p>
+ <s2 title="WebContinuation">
+ <p>A <code>WebContinuation</code> represents a continuation of a Flowscript. Because a user may click on the back button in the browser and restart a saved computation in a continuation, each <code>WebContinuation</code> becomes the parent of a subtree of 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.
+ </p>
+ <p>
+ <code>WebContinuation</code> objects support the following functions and properties:
+ </p>
+ <p>
+ Function <code>invalidate()</code>
+ </p>
+ <p>
+ Invalidates a <code>WebContinuation</code>. This effectively
+ means that the continuation object associated with it will no
+ longer be accessible from Web pages. Invalidating a
+ <code>WebContinuation</code> invalidates all the
+ <code>WebContinuation</code>s which are children of it.
+ </p>
+ <p>
+ Property <code>[String] id</code>
+ </p>
+ <p>
+ Returns this object's unique identifier as a String
+ </p>
+ </s2>
</s1>
</body>
</document>