1   /*
2    * Copyright 2000-2001,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  /* 
18  
19   */
20  
21  package org.apache.wsrp4j.consumer;
22  
23  import java.util.Iterator;
24  
25  import org.apache.wsrp4j.exception.WSRPException;
26  
27  /**
28   * This interface defines a registry which holds portlet objects.
29   *
30   * @author Stephan Laertz 
31   **/
32  public interface PortletRegistry {
33  
34      /**
35       * Add a portlet to the registry
36       *
37       * @param portlet The portlet to add
38       */
39      public void addPortlet(WSRPPortlet portlet) throws WSRPException;
40  
41      /**
42       * Get the portlet for the given producer and portlet handle
43       *
44       * @param portletKey The portlet key identifying the portlet
45       *
46       * @return The portlet with the given portlet key
47       **/
48      public WSRPPortlet getPortlet(PortletKey portletKey);
49  
50      /**
51       * Remove the portlet with the given portlet key
52       *
53       * @param portletKey The portlet key identifying the portlet
54       * @return The portlet which has been removed or null
55       **/
56      public WSRPPortlet removePortlet(PortletKey portletKey);
57  
58      /**
59       * Tests if a portlet with the given portlet key
60       * 
61       * @param portletKey The portlet key identifying the portlet
62       * 
63       * @return True if portlet exists with this portlet key
64       **/
65      public boolean existsPortlet(PortletKey portletKey);
66  
67      /**
68       * Get all the portlets in the register
69       * 
70       * @return Iterator with all portlets in the registry
71       **/
72      public Iterator getAllPortlets();
73  
74      /**
75       * Remove all portlets from the registry
76       **/
77      public void removeAllPortlets();
78  
79  }