KickJava   Java API By Example, From Geeks To Geeks.

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


1 package org.exoplatform.services.wsrp.consumer;
2
3 /**
4  * Defines the information which uniquely identifies an portlet provided by a producer.
5  * The portlet key does not identify a use of an portlet
6  *
7  * @author <a HREF='mailto:Stephan.Laertz@de.ibm.com'>Stephan Laertz</a>
8  * @author Benjamin Mestrallet
9  */
10 public interface PortletKey {
11
12   /**
13    * Get the portlet handle which identifies an portlet in the scope of one producer
14    *
15    * @return The portlet handle
16    */
17   public String JavaDoc getPortletHandle();
18
19   /**
20    * Set the portlet handle which identifies an portlet in the scope of one producer
21    *
22    * @param portletHandle The portlet handle
23    */
24   public void setPortletHandle(String JavaDoc portletHandle);
25
26   /**
27    * Get the ID of the producer providing the portlet
28    *
29    * @return The ID of the producer
30    */
31   public String JavaDoc getProducerId();
32
33   /**
34    * Set the ID of the producer providing the portlet
35    *
36    * @param id The ID of the producer
37    */
38   public void setProducerId(String JavaDoc id);
39 }
40
Popular Tags