org.apache.cocoon.components.flow
Class FlowHelper

java.lang.Object
  org.apache.cocoon.components.flow.FlowHelper

public class FlowHelper

extends Object

Provides the interface between the flow controller layer and the view layer. A view can obtain the context object sent by a flow script and the current web continuation, if any.

Constructor Summary

FlowHelper()

Method Summary

static Object	getContextObject(Map objectModel) Get the flow context object associated with the current request
static org.apache.cocoon.components.flow.WebContinuation	getWebContinuation(Map objectModel) Get the web continuation associated with the current request
static void	setContextObject(Map objectModel, org.apache.cocoon.el.objectmodel.ObjectModel newObjectModel, Object obj) Set the flow context object associated with the current request
static void	setWebContinuation(Map objectModel, org.apache.cocoon.el.objectmodel.ObjectModel newObjectModel, org.apache.cocoon.components.flow.WebContinuation kont) Set the web continuation associated with the current request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlowHelper

public FlowHelper()

Method Detail

getContextObject

public static final Object getContextObject(Map objectModel)

Get the flow context object associated with the current request

Parameters:

objectModel - The Cocoon Environment's object model

Returns:

The context object

getWebContinuation

public static final org.apache.cocoon.components.flow.WebContinuation getWebContinuation(Map objectModel)

Get the web continuation associated with the current request

Parameters:

objectModel - The Cocoon Environment's object model

Returns:

The web continuation

setWebContinuation

public static final void setWebContinuation(Map objectModel,
                                            org.apache.cocoon.el.objectmodel.ObjectModel newObjectModel,
                                            org.apache.cocoon.components.flow.WebContinuation kont)

Set the web continuation associated with the current request

Parameters:

objectModel - The Cocoon Environment's object model

newObjectModel - TODO

kont - The web continuation

setContextObject

public static final void setContextObject(Map objectModel,
                                          org.apache.cocoon.el.objectmodel.ObjectModel newObjectModel,
                                          Object obj)

Set the flow context object associated with the current request

Parameters:

objectModel - The Cocoon Environment's object model

newObjectModel - TODO

obj - The context object