FlowHelper (Cocoon API 2.1.12-dev [March 20 2012])

This project has retired. For details please refer to its Attic page.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.cocoon.components.flow
Class FlowHelper

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

Direct Known Subclasses:: JavaScriptFlowHelper

public class FlowHelper
extends Object
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 WebContinuation getWebContinuation(Map objectModel)
          Get the web continuation associated with the current request

static void setContextObject(Map objectModel, Object obj)
          Set the flow context object associated with the current request

static void setWebContinuation(Map objectModel, WebContinuation kont)
          Set the web continuation associated with the current request

static Object unwrap(Object obj)
          Deprecated. Use JavaScriptFlowHelper.unwrap(Object)

Methods inherited from class java.lang.Object

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

Constructor Summary
`FlowHelper()`

Method Summary
`static Object`	`getContextObject(Map objectModel)` Get the flow context object associated with the current request
`static WebContinuation`	`getWebContinuation(Map objectModel)` Get the web continuation associated with the current request
`static void`	`setContextObject(Map objectModel, Object obj)` Set the flow context object associated with the current request
`static void`	`setWebContinuation(Map objectModel, WebContinuation kont)` Set the web continuation associated with the current request
`static Object`	`unwrap(Object obj)` Deprecated. Use `JavaScriptFlowHelper.unwrap(Object)`

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 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,
                                            WebContinuation kont)

Set the web continuation associated with the current request

Parameters:: objectModel - The Cocoon Environment's object model; kont - The web continuation

setContextObject

public static final void setContextObject(Map objectModel,
                                          Object obj)

Set the flow context object associated with the current request

Parameters:: objectModel - The Cocoon Environment's object model; obj - The context object

unwrap

public static Object unwrap(Object obj)

Deprecated. Use JavaScriptFlowHelper.unwrap(Object)

Unwrap a Rhino object (getting the raw java object) and convert undefined to null