interface Cocoon

cocoon
   |
   +--cocoon.Cocoon

The Cocoon interface defines the main Cocoon liaison available to flow scripts.

interface Cocoon

sendPage

void sendPage(in string url, in Object bean)
 raises (
java::Exception)

Passes control to the Cocoon sitemap to generate the output page.

TODO: What happens when the control returns to a script which (for example) calls again sendPage(AndWait)???

Parameter

uri - the relative URL of the page to be sent back to the client.
bean - a context object which can be accessed inside this page to extract various values and place them in the generated page.

Exception

java::Exception - If an error occurred attempting to send the specified page.

sendPageAndWait

cocoon::Continuation sendPageAndWait(in string url, in Object bean, in long ttl)
 raises (
java::Exception)

Passes control to the Cocoon sitemap to generate the output page, interrupting the execution until another request comes in.

The flow script is suspended after the page is generated and the whole execution stack saved in a Continuation. This instance is returned to the caller once the next request triggers the continuation of the current execution stack.

TODO: Explain in better English what exactly goes on here.

Parameter

uri - the relative URL of the page to be sent back to the client.
bean - a context object which can be accessed inside this page to extract various values and place them in the generated page.
ttl - The time to leave in milliseconds of the newly created Continuation instance.

Return

The Continuation instance associated with this current execution stack.

Exception

java::Exception - If an error occurred attempting to send the specified page, or creating a new Continuation instance.

contxt

readonly attribute cocoon::Context contxt

The current Context instance. (suggested by Stefano Mazzocchi)

NOTE: "context" is a reserved word in IDL (at least it seems so). This name has been mangled accordingly to allow IDLDoc to produce the documentation.

log

readonly attribute cocoon::Log log

The current Log instance used for logging. (suggested by Jeremy Quinn).

request

readonly attribute cocoon::Request request

The current Request instance associated with this script. (suggested by Stefano Mazzocchi)