KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > portal > wsrp > consumer > SimplePortletWindowSessionImpl


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.PortletSession;
19 import org.apache.wsrp4j.consumer.driver.GenericPortletWindowSessionImpl;
20
21 /**
22  * Holds the parameters for displaying the portlet in a portlet-window.<br/>
23  * The attributes <tt>windowState</tt>, <tt>portletMode</tt> and the navigationalState
24  * are representing all preferences of the portlet-window. <br/>
25  *
26  * @author <a HREF="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
27  * @author <a HREF="mailto:malessandrini@s-und-n.de">Michel Alessandrini</a>
28  *
29  * @version $Id: SimplePortletWindowSessionImpl.java 264755 2005-08-30 10:29:21Z cziegeler $
30  */
31 public class SimplePortletWindowSessionImpl
32     extends GenericPortletWindowSessionImpl
33     implements SimplePortletWindowSession {
34
35     /** The windowState the portlet has (minimized, normal, maximized)
36      * @see org.apache.wsrp4j.util.Constants */
37     private String JavaDoc windowState;
38
39     /** The portletMode the portlet has (minimized, normal, maximized)
40      * @see org.apache.wsrp4j.util.Constants */
41     private String JavaDoc mode;
42
43     /** The navigationalState of the portlet */
44     private String JavaDoc navState;
45
46     /**
47      * Constructor
48      *
49      * @param windowID
50      * @param pSession
51      */
52     public SimplePortletWindowSessionImpl(
53         String JavaDoc windowID,
54         PortletSession pSession) {
55         super(windowID, pSession);
56     }
57    
58     /**
59      * Get the window state of the portlet window
60      * this session belongs to<br/>
61      *
62      * @return the window state
63      **/
64     public String JavaDoc getWindowState() {
65         return windowState;
66     }
67
68    /**
69     * Get the portlet mode<br/>
70     *
71     * @return The portlet mode of the portlet window.
72     **/
73     public String JavaDoc getMode() {
74         return mode;
75     }
76
77     /**
78      * Set the window state of the portlet instance
79      * this session belongs to<br/>
80      *
81      * @param windowState The window state of the portlet window
82      **/
83     public void setWindowState(String JavaDoc windowState) {
84         this.windowState = windowState;
85     }
86
87     /**
88      * Set the portlet mode<br/>
89      *
90      * @param mode The portlet mode of the portlet window
91      **/
92     public void setMode(String JavaDoc mode) {
93         this.mode = mode;
94     }
95     
96     /**
97      * @see org.apache.cocoon.portal.wsrp.consumer.SimplePortletWindowSession#getNavigationalState()
98      */
99     public String JavaDoc getNavigationalState() {
100         return navState;
101     }
102
103     /**
104      * @see org.apache.cocoon.portal.wsrp.consumer.SimplePortletWindowSession#setNavigationalState(java.lang.String)
105      */
106     public void setNavigationalState(String JavaDoc navState) {
107         this.navState = navState;
108     }
109 }
110
Popular Tags