org.apache.jetspeed.container.window
Interface PortletWindowAccessor

public interface PortletWindowAccessor

Portlet Window Accessor

Version:

$Id: PortletWindowAccessor.java,v 1.7 2005/04/29 13:59:46 weaver Exp $

Author:

David Sean Taylor

Method Summary

org.apache.pluto.om.window.PortletWindow	createPortletWindow(org.apache.pluto.om.entity.PortletEntity entity, String windowId) Given a portlet entity, create a portlet window for that entity.
org.apache.pluto.om.window.PortletWindow	createPortletWindow(String windowId) Create a temporary portlet window This window does not have an entity associated with it.
org.apache.pluto.om.window.PortletWindow	getPortletWindow(ContentFragment fragment) Get a portlet window for the given fragment
org.apache.pluto.om.window.PortletWindow	getPortletWindow(ContentFragment fragment, String principal) Get the portlet window for a fragment and given principal
org.apache.pluto.om.window.PortletWindow	getPortletWindow(String windowId) Lookup a portlet window in the cache If not found, return null
Set	getPortletWindows() Gets a Set of currently available PortletWindows within the current engine instance.
void	removeWindow(org.apache.pluto.om.window.PortletWindow window) removeWindow
void	removeWindows(org.apache.pluto.om.entity.PortletEntity portletEntity) removeWindows

Method Detail

getPortletWindow

org.apache.pluto.om.window.PortletWindow getPortletWindow(ContentFragment fragment)
                                                          throws FailedToRetrievePortletWindow,
                                                                 PortletEntityNotStoredException

Get a portlet window for the given fragment

Parameters:

fragment -

Returns:

Throws:

FailedToRetrievePortletWindow

PortletEntityNotStoredException

InconsistentWindowStateException - If the window references a non-existsent PortletEntity

getPortletWindow

org.apache.pluto.om.window.PortletWindow getPortletWindow(ContentFragment fragment,
                                                          String principal)
                                                          throws FailedToCreateWindowException,
                                                                 FailedToRetrievePortletWindow,
                                                                 PortletEntityNotStoredException

Get the portlet window for a fragment and given principal

Parameters:

fragment -

principal -

Returns:

Throws:

FailedToCreateWindowException

FailedToRetrievePortletWindow

PortletEntityNotStoredException

InconsistentWindowStateException - If the window references a non-existsent PortletEntity

getPortletWindow

org.apache.pluto.om.window.PortletWindow getPortletWindow(String windowId)

Lookup a portlet window in the cache If not found, return null

Parameters:

windowId -

Returns:

the window from the cache or null

createPortletWindow

org.apache.pluto.om.window.PortletWindow createPortletWindow(org.apache.pluto.om.entity.PortletEntity entity,
                                                             String windowId)

Given a portlet entity, create a portlet window for that entity.

Parameters:

entity -

windowId -

Returns:

new window

createPortletWindow

org.apache.pluto.om.window.PortletWindow createPortletWindow(String windowId)

Create a temporary portlet window This window does not have an entity associated with it.

Parameters:

windowId -

Returns:

removeWindows

void removeWindows(org.apache.pluto.om.entity.PortletEntity portletEntity)

removeWindows

Removes all PortletWindows associated with this PortletEntity

Parameters:

portletEntity -

removeWindow

void removeWindow(org.apache.pluto.om.window.PortletWindow window)

removeWindow

Removes a PortletWindow from the window cache.

Parameters:

window -

getPortletWindows

Set getPortletWindows()

Gets a Set of currently available PortletWindows within the current engine instance.

Returns:

Set of PortletWindows, never returns null