SimplePortletWindowSession


1   /*
2    * Copyright 2005 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  package org.apache.cocoon.portal.wsrp.consumer;
17  
18  import org.apache.wsrp4j.consumer.PortletWindowSession;
19  
20  /**
21   * Defines a portlet window session used by the cocoon portal
22   * In additional to <code>SimplePortletWindowSession</code>
23   * it contains information about the current window state and mode of a portlet window.<br/>
24   *
25   * @author <a HREF="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
26   * @author <a HREF="mailto:malessandrini@s-und-n.de">Michel Alessandrini</a>
27   *
28   * @version $Id: SimplePortletWindowSession.java 264755 2005-08-30 10:29:21Z cziegeler $
29   **/
30  public interface SimplePortletWindowSession extends PortletWindowSession {
31  
32      /**
33       * Get the window state of the portlet window 
34       * this session belongs to.<br/>
35       * 
36       * @return the window state
37       **/
38      String   getWindowState();
39  
40      /**
41       * Set the window state of the portlet window
42       * this session belongs to.<br/>
43       * 
44       * @param windowState The window state
45       **/
46      void setWindowState(String   windowState);
47  
48      /**
49       * Get the portlet mode of the portlet window.<br/>
50       * 
51       * @return The portlet mode 
52       **/
53      String   getMode();
54  
55      /**
56       * Set the portlet mode of the portlet window.<br/>
57       * 
58       * @param mode The portlet mode
59       **/
60      void setMode(String   mode);
61      
62      /**
63       * Get the navigational state for the portlet window the session belongs to<br/>
64       * 
65       * @return the navigational state
66       **/
67      String   getNavigationalState();
68      
69      /**
70       * Set the navigational state for the portlet window the session belongs to<br/>
71       * 
72       * @param navState the navigational state
73       **/
74      void setNavigationalState(String   navState);
75  }
76
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags