KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > exoplatform > services > wsrp > consumer > PortletRegistry


1 package org.exoplatform.services.wsrp.consumer;
2
3
4 import java.util.Iterator JavaDoc;
5 import org.exoplatform.services.wsrp.exceptions.WSRPException;
6
7
8 /**
9  * This interface defines a registry which holds portlet objects.
10  *
11  * @author Stephan Laertz
12  * @author Benjamin Mestrallet
13  */
14 public interface PortletRegistry {
15
16   /**
17    * Add a portlet to the registry
18    *
19    * @param portlet The portlet to add
20    */
21   public void addPortlet(WSRPPortlet portlet) throws WSRPException;
22
23   /**
24    * Get the portlet for the given producer and portlet handle
25    *
26    * @param portletKey The portlet key identifying the portlet
27    * @return The portlet with the given portlet key
28    */
29   public WSRPPortlet getPortlet(PortletKey portletKey);
30
31   /**
32    * Remove the portlet with the given portlet key
33    *
34    * @param portletKey The portlet key identifying the portlet
35    * @return The portlet which has been removed or null
36    */
37   public WSRPPortlet removePortlet(PortletKey portletKey);
38
39   /**
40    * Tests if a portlet with the given portlet key
41    *
42    * @param portletKey The portlet key identifying the portlet
43    * @return True if portlet exists with this portlet key
44    */
45   public boolean existsPortlet(PortletKey portletKey);
46
47   /**
48    * Get all the portlets in the register
49    *
50    * @return Iterator with all portlets in the registry
51    */
52   public Iterator JavaDoc getAllPortlets();
53
54   /**
55    * Remove all portlets from the registry
56    */
57   public void removeAllPortlets();
58
59 }
60
Popular Tags