KickJava   Java API By Example, From Geeks To Geeks.

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


1 package org.exoplatform.services.wsrp.consumer;
2
3 import org.exoplatform.services.wsrp.type.PortletContext;
4
5 /**
6  * Defines a consumer-side representation of a remote portlet.
7  * A portlet is uniquely identified by its portlet key.
8  * Consumer configured portlets are the result of clone operations on
9  * existing portlets (parents).
10  *
11  * @author Stephan Laertz
12  * @author Benjamin Mestrallet
13  */
14 public interface WSRPPortlet {
15
16   /**
17    * Get the portlet key of the portlet. The key can be used to reference
18    * to the portlet.
19    *
20    * @return a portlet key object
21    */
22   public PortletKey getPortletKey();
23
24   /**
25    * Set the portlet key of the portlet.
26    *
27    * @param portletKey The portlet key of the portlet
28    */
29   public void setPortletKey(PortletKey portletKey);
30
31   /**
32    * Get the portlet context object which contains information about
33    * the portlet state.
34    *
35    * @return the portlet context object of the portlet.
36    */
37   public PortletContext getPortletContext();
38
39   /**
40    * Set the portlet context of the portlet.
41    *
42    * @param portletContext The portlet context of the portlet
43    */
44   public void setPortletContext(PortletContext portletContext);
45
46   /**
47    * Checks if a portlet is consumer configured portlet.
48    *
49    * @return True if the result <code>getParent()</code> is not equal
50    * to the portlet handle of the portlet key.
51    */
52   public boolean isConsumerConfigured();
53
54   /**
55    * Get the portlet handle of the parent portlet. If the portlet
56    * is not a consumer configured portlet the handle returned by this method
57    * should be the same as the handle in the portlet key returned
58    * by <code>getPortletKey</code>.
59    *
60    * @return the portlet handle of the parent portlet.
61    */
62   public String JavaDoc getParent();
63
64   /**
65    * Set the portlet handle of the parent portlet. If the supplied
66    * handle is not equal to the handle in the portlet key returned by
67    * <code>getPortletKey</code> this method makes the portlet a
68    * consumer configured portlet.
69    *
70    * @param portletHandle the portlet handle of the parent portlet
71    */
72   public void setParent(String JavaDoc portletHandle);
73 }
74
Popular Tags