org.apache.pluto
Interface PortletWindow

All Known Subinterfaces:
InternalPortletWindow
All Known Implementing Classes:
InternalPortletWindowImpl, PortletWindowImpl

public interface PortletWindow

Thin representation of the portlet window for which the container request should be processed. The PortletWindow is used internally to map the request to the configured Portlet Application and Portlet.

Since:
Sep 22, 2004
Version:
1.0
See Also:
InternalPortletWindowImpl, PortletDD

Method Summary
 java.lang.String getContextPath()
          Retrieve the context path in which the Portlet resides.
 PortletWindowID getId()
          Retrieve this windows unique id which will be used to communicate back to the referencing portal.
 PortletMode getPortletMode()
          Retrieve the current portlet mode for this window.
 java.lang.String getPortletName()
          Retrieve the name of the portlet as configured in the portlet.xml.
 WindowState getWindowState()
          Retrieve the current window state for this window.
 

Method Detail

getId

PortletWindowID getId()
Retrieve this windows unique id which will be used to communicate back to the referencing portal.

Returns:
unique id.

getContextPath

java.lang.String getContextPath()
Retrieve the context path in which the Portlet resides.

Returns:
context path

getPortletName

java.lang.String getPortletName()
Retrieve the name of the portlet as configured in the portlet.xml.

Returns:
the name of the portlet.

getWindowState

WindowState getWindowState()
Retrieve the current window state for this window.

Returns:
the current window state.

getPortletMode

PortletMode getPortletMode()
Retrieve the current portlet mode for this window.

Returns:
the current portlet mode.


Copyright © 2003-2010 Apache Software Foundation. All Rights Reserved.