org.exoplatform.services.wsrp.consumer
Interface PortletRegistry

All Known Implementing Classes:

PortletRegistryImpl

public interface PortletRegistry

This interface defines a registry which holds portlet objects.

Author:

Stephan Laertz, Benjamin Mestrallet

Method Summary

void	addPortlet(WSRPPortlet portlet) Add a portlet to the registry
boolean	existsPortlet(PortletKey portletKey) Tests if a portlet with the given portlet key
Iterator<WSRPPortlet>	getAllPortlets() Get all the portlets in the register
WSRPPortlet	getPortlet(PortletKey portletKey) Get the portlet for the given producer and portlet handle
void	removeAllPortlets() Remove all portlets from the registry
WSRPPortlet	removePortlet(PortletKey portletKey) Remove the portlet with the given portlet key

Method Detail

addPortlet

void addPortlet(WSRPPortlet portlet)
                throws WSRPException

Add a portlet to the registry

Parameters:

portlet - The portlet to add

Throws:

WSRPException

getPortlet

WSRPPortlet getPortlet(PortletKey portletKey)

Get the portlet for the given producer and portlet handle

Parameters:

portletKey - The portlet key identifying the portlet

Returns:

The portlet with the given portlet key

removePortlet

WSRPPortlet removePortlet(PortletKey portletKey)

Remove the portlet with the given portlet key

Parameters:

portletKey - The portlet key identifying the portlet

Returns:

The portlet which has been removed or null

existsPortlet

boolean existsPortlet(PortletKey portletKey)

Tests if a portlet with the given portlet key

Parameters:

portletKey - The portlet key identifying the portlet

Returns:

True if portlet exists with this portlet key

getAllPortlets

Iterator<WSRPPortlet> getAllPortlets()

Get all the portlets in the register

Returns:

Iterator with all portlets in the registry

removeAllPortlets

void removeAllPortlets()

Remove all portlets from the registry