org.jasig.portal.api.portlet
Interface PortletDelegationLocator

All Known Implementing Classes:

PortletDelegationLocatorImpl

public interface PortletDelegationLocator

Creates PortletDelegationDispatcher instances that can be used to execute another portlet as a child.

Version:

$Revision$

Author:

Eric Dalquist

Field Summary

static String

PORTLET_DELECATION_LOCATOR_ATTR The PortletDelegationLocator instance will be available in the request under this key

Method Summary

PortletDelegationDispatcher	createRequestDispatcher(PortletRequest request, IPortletDefinitionId portletDefinitionId) Creates a new portlet delegation dispatcher and corresponding portlet window
PortletDelegationDispatcher	createRequestDispatcher(PortletRequest request, String fName) Creates a new portlet delegation dispatcher and corresponding portlet window
PortletDelegationDispatcher	getRequestDispatcher(PortletRequest request, IPortletWindowId portletWindowId) Get an existing delegation dispatcher for an existing portlet window.

Field Detail

PORTLET_DELECATION_LOCATOR_ATTR

static final String PORTLET_DELECATION_LOCATOR_ATTR

The PortletDelegationLocator instance will be available in the request under this key

Method Detail

createRequestDispatcher

PortletDelegationDispatcher createRequestDispatcher(PortletRequest request,
                                                    String fName)

Creates a new portlet delegation dispatcher and corresponding portlet window

Parameters:

request - The current request

fName - The functional name of the portlet to create a dispatcher for

Returns:

Null if no portlet exists for the specified fname

createRequestDispatcher

PortletDelegationDispatcher createRequestDispatcher(PortletRequest request,
                                                    IPortletDefinitionId portletDefinitionId)

Creates a new portlet delegation dispatcher and corresponding portlet window

Parameters:

request - The current request

portletDefinitionId - The portlet definition id of the portlet to create a dispatcher for

Returns:

The dispatcher

getRequestDispatcher

PortletDelegationDispatcher getRequestDispatcher(PortletRequest request,
                                                 IPortletWindowId portletWindowId)

Get an existing delegation dispatcher for an existing portlet window.

Parameters:

request - The current request

portletWindowId - The IPortletWindowId from the previously created dispatcher

Returns:

The previously created dispatcher, null if no dispatcher exists for the ID