com.webmethods.portal.framework

Interface IPortletContainer

All Superinterfaces:

IComponent, IComponentProvider, IInitializable, IURIResolver

public interface IPortletContainer
extends IComponentProvider

Portlet container

Field Summary

Fields inherited from interface com.webmethods.portal.system.IComponentProvider

ATTR_APP_NAME, ATTR_BEG_QUERY, ATTR_END_QUERY, ATTR_MID_QUERY, BIZPOLICY_MANAGER, CACHE_PROVIDER, COMMAND_PROVIDER, COMPONENTS_QUERY, INSTALL_PROVIDER, MECH_PROVIDER, METACONTEXT_PROVIDER, PHASE_PROVIDER, POLICY_PROVIDER, SEARCH_PROVIDER

Method Summary

Modifier and Type	Method and Description
IPortletApplication	getPortletApplication(String portletAppName) Returns portlet application component by its name.
Collection<javax.portlet.PortletMode>	getPortletModes(String portletAppName, String portletName, String contentType)
Collection<javax.portlet.PortletMode>	getSupportedPortletModes()
Collection<javax.portlet.WindowState>	getSupportedWindowStates()
Collection<javax.portlet.WindowState>	getWindowStates(String portletApplicationName)
boolean	isModeSuported(String portletAppName, String portletName, String contentType, javax.portlet.PortletMode mode)
boolean	isPortletModeSupported(javax.portlet.PortletMode portletMode)
boolean	isStateSupported(javax.portlet.WindowState state, String portletApplication)
boolean	isWindowStateSupported(javax.portlet.WindowState windowState)
IActionResponseData	processPortletAction(HttpServletRequest request, HttpServletResponse response, IActionRequestData actionRequestData) Processes portlet'a action based on http request/response and renderRequestData
void	registerPortletApplication(ServletContext servletContext) Registers portlet application.
IRenderResponseData	renderPortlet(HttpServletRequest request, HttpServletResponse response, IRenderRequestData renderRequestData) Renders portlet based on http request/response and renderRequestData
void	unregisterPortletApplication(ServletContext servletContext) Unregisters portlet application.

Methods inherited from interface com.webmethods.portal.system.IComponentProvider

exists, getComponent, getComponent, getComponent, getComponentQueryString, getComponents, getDefaultComponent, getLogger, initDeferredWebAppComponents, lookup, registerComponent, reloadComponent, reloadComponent, unregisterComponent, upgradeComponentDataFromBootstrapComponentData

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Methods inherited from interface com.webmethods.portal.system.IURIResolver

acquireURI, acquireURI

Method Detail

registerPortletApplication

void registerPortletApplication(ServletContext servletContext)
                         throws PortalException

Registers portlet application. Loads and makes availalbe all the portlets in this application.

Parameters:

servletContext - portlet application servlet context

Throws:

PortalException

unregisterPortletApplication

void unregisterPortletApplication(ServletContext servletContext)

Unregisters portlet application. Makes unavailable and unloads all portlets from this application.

Parameters:

servletContext - portlet application servlet context

getPortletApplication

IPortletApplication getPortletApplication(String portletAppName)

Returns portlet application component by its name. Portlet application component is portlet provider.

Parameters:

portletAppName - the application name

Returns:

portlet provider for this portlet application or null if not found.

renderPortlet

IRenderResponseData renderPortlet(HttpServletRequest request,
                                  HttpServletResponse response,
                                  IRenderRequestData renderRequestData)
                           throws PortalException

Renders portlet based on http request/response and renderRequestData

Parameters:

request - current http servlet request

response - current http servlet response

renderRequestData - portlet render request data

Returns:

render response data

Throws:

PortalException

processPortletAction

IActionResponseData processPortletAction(HttpServletRequest request,
                                         HttpServletResponse response,
                                         IActionRequestData actionRequestData)
                                  throws PortalException

Processes portlet'a action based on http request/response and renderRequestData

Parameters:

request - current http servlet request

response - current http servlet response

actionRequestData - portlet action request data

Returns:

action response data

Throws:

PortalException

getSupportedPortletModes

Collection<javax.portlet.PortletMode> getSupportedPortletModes()

isPortletModeSupported

boolean isPortletModeSupported(javax.portlet.PortletMode portletMode)

getSupportedWindowStates

Collection<javax.portlet.WindowState> getSupportedWindowStates()

isWindowStateSupported

boolean isWindowStateSupported(javax.portlet.WindowState windowState)

getPortletModes

Collection<javax.portlet.PortletMode> getPortletModes(String portletAppName,
                                                      String portletName,
                                                      String contentType)

isModeSuported

boolean isModeSuported(String portletAppName,
                       String portletName,
                       String contentType,
                       javax.portlet.PortletMode mode)

getWindowStates

Collection<javax.portlet.WindowState> getWindowStates(String portletApplicationName)

isStateSupported

boolean isStateSupported(javax.portlet.WindowState state,
                         String portletApplication)