com.webmethods.caf.portlet

Interface IPortletProvider

public interface IPortletProvider

Field Summary

Fields

Modifier and Type	Field and Description
static String	PORTLET_TYPE_KEY Used to pass portlet creation information
static String	PORTLET_URI
static String	REQUEST_MAP_KEY Key to use to find implementation of IPortletProvider under ExternalContext.getRequestMap()

Method Summary

Modifier and Type	Method and Description
String	getPortletNamespace(String portlet) Returns portlet namespace for specified portlet identifier.
Reader	renderPortlet(String portlet, String layout, Map<String,Object> properties) Renders portlet content and returns reader

Field Detail

REQUEST_MAP_KEY

static final String REQUEST_MAP_KEY

Key to use to find implementation of IPortletProvider under ExternalContext.getRequestMap()

See Also:

Constant Field Values

PORTLET_TYPE_KEY

static final String PORTLET_TYPE_KEY

Used to pass portlet creation information

See Also:

Constant Field Values

PORTLET_URI

static final String PORTLET_URI

See Also:

Constant Field Values

Method Detail

getPortletNamespace

String getPortletNamespace(String portlet)

Returns portlet namespace for specified portlet identifier.

Parameters:

portlet - Portlet identifier (thingID or alias).

Returns:

Portlet namespace, or null if portlet identifier is invalid.

Throws:

Exception

renderPortlet

Reader renderPortlet(String portlet,
                     String layout,
                     Map<String,Object> properties)
              throws Exception

Renders portlet content and returns reader

Parameters:

portlet - portlet identifier (thingID or alias) to render

layout - legacy portlet layout to render. If null default layout will be used

Returns:

Reader instance with portlet content

Throws:

Exception