org.apache.pluto
Interface PortletWindow

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:

PortletDefinition

Method Summary

PortletWindowID	getId() Retrieve this windows unique id which will be used to communicate back to the referencing portal.
PortletEntity	getPortletEntity() Returns the portlet entity.
javax.portlet.PortletMode	getPortletMode() Retrieve the current portlet mode for this window.
javax.portlet.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.

getWindowState

javax.portlet.WindowState getWindowState()

Retrieve the current window state for this window.

Returns:

the current window state.

getPortletMode

javax.portlet.PortletMode getPortletMode()

Retrieve the current portlet mode for this window.

Returns:

the current portlet mode.

getPortletEntity

PortletEntity getPortletEntity()

Returns the portlet entity. The return value cannot be NULL.

Returns:

the portlet entity