KickJava   Java API By Example, From Geeks To Geeks.

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


1 package org.exoplatform.services.wsrp.consumer;
2
3 import org.exoplatform.services.wsrp.type.MarkupContext;
4
5
6 /**
7  * The portlet window session is a session which is unique for
8  * every window of a portlet instance.
9  */
10 public interface PortletWindowSession {
11   /**
12    * Get the ID of the portlets window this session belongs to.
13    *
14    * @return The ID of the portlet window.
15    */
16   public String JavaDoc getWindowID();
17
18   /**
19    * Set the ID of the portlets window this sessions belongs to.
20    *
21    * @param windowID The ID of the portlet window.
22    */
23   public void setWindowID(String JavaDoc windowID);
24
25   /**
26    * Get the markup context which has been cached. This might be useful
27    * to retrieve the markup which was returned <code>performBlockingInteraction</code>
28    * calls in order to save an additional <code>getMarkup</code> call.
29    *
30    * @return The cached markup context or null in case the cache is empty.
31    */
32   public MarkupContext getCachedMarkup();
33
34   /**
35    * Update the cache which holds the markup context. This might be useful
36    * to store the markup which was returned by <code>performBlockingInteraction</code>
37    * calls in order to save an additional <code>getMarkup</code> call.
38    * Updateing the cache with a null value clears the markup cache.
39    */
40   public void updateMarkupCache(MarkupContext markupContext);
41
42   /**
43    * Get the portlet session this window session belongs to.
44    *
45    * @return The <code>PortletSession</code> this window session belongs to.
46    */
47   public PortletSession getPortletSession();
48
49   public void setNavigationalState(String JavaDoc navigationalState);
50
51   public String JavaDoc getNavigationalState();
52 }
53
Popular Tags