portletrequestwrapper.html.svn-base

portal越来越流行了

<DD><DL>

<DT><B>Returns:</B><DD>the portlet window ID</DL>
</DD>
</DL>
<HR>

<A NAME="getWindowState()"><!-- --></A><H3>
getWindowState</H3>
<PRE>
public <A HREF="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</A> <B>getWindowState</B>()</PRE>
<DL>
<DD>The default behavior of this method is to call 
 <code>getWindowState()</code> on the wrapped request object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/portlet/PortletRequest.html#getWindowState()">getWindowState</A></CODE> in interface <CODE><A HREF="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the window state</DL>
</DD>
</DL>
<HR>

<A NAME="isPortletModeAllowed(javax.portlet.PortletMode)"><!-- --></A><H3>
isPortletModeAllowed</H3>
<PRE>
public boolean <B>isPortletModeAllowed</B>(<A HREF="../../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</A>&nbsp;mode)</PRE>
<DL>
<DD>The default behavior of this method is to call 
 <code>isPortletModeAllowed(mode)</code> on the wrapped request object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/portlet/PortletRequest.html#isPortletModeAllowed(javax.portlet.PortletMode)">isPortletModeAllowed</A></CODE> in interface <CODE><A HREF="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mode</CODE> - portlet mode to check
<DT><B>Returns:</B><DD>true, if it is valid for this portlet
             in this request to change to the
            given portlet mode</DL>
</DD>
</DL>
<HR>

<A NAME="isRequestedSessionIdValid()"><!-- --></A><H3>
isRequestedSessionIdValid</H3>
<PRE>
public boolean <B>isRequestedSessionIdValid</B>()</PRE>
<DL>
<DD>The default behavior of this method is to call 
 <code>isRequestedSessionIdValid()</code> on the wrapped request object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/portlet/PortletRequest.html#isRequestedSessionIdValid()">isRequestedSessionIdValid</A></CODE> in interface <CODE><A HREF="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD><code>true</code> if this
                                request has an id for a valid session
                                in the current session context;
                                <code>false</code> otherwise<DT><B>See Also:</B><DD><A HREF="../../../javax/portlet/PortletRequest.html#getRequestedSessionId()"><CODE>PortletRequest.getRequestedSessionId()</CODE></A>, 
<A HREF="../../../javax/portlet/PortletRequest.html#getPortletSession()"><CODE>PortletRequest.getPortletSession()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="isSecure()"><!-- --></A><H3>
isSecure</H3>
<PRE>
public boolean <B>isSecure</B>()</PRE>
<DL>
<DD>The default behavior of this method is to call 
 <code>isSecure()</code> on the wrapped request object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/portlet/PortletRequest.html#isSecure()">isSecure</A></CODE> in interface <CODE><A HREF="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true, if the request was made using a secure channel.</DL>
</DD>
</DL>
<HR>

<A NAME="isUserInRole(java.lang.String)"><!-- --></A><H3>
isUserInRole</H3>
<PRE>
public boolean <B>isUserInRole</B>(java.lang.String&nbsp;role)</PRE>
<DL>
<DD>The default behavior of this method is to call 
 <code>isUserInRole(role)</code> on the wrapped request object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/portlet/PortletRequest.html#isUserInRole(java.lang.String)">isUserInRole</A></CODE> in interface <CODE><A HREF="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>role</CODE> - a <code>String</code> specifying the name
                                of the role
<DT><B>Returns:</B><DD>a <code>boolean</code> indicating whether
                        the user making this request belongs to a given role;
                        <code>false</code> if the user has not been 
                        authenticated.</DL>
</DD>
</DL>
<HR>

<A NAME="isWindowStateAllowed(javax.portlet.WindowState)"><!-- --></A><H3>
isWindowStateAllowed</H3>
<PRE>
public boolean <B>isWindowStateAllowed</B>(<A HREF="../../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</A>&nbsp;state)</PRE>
<DL>
<DD>The default behavior of this method is to call 
 <code>isWindowStateAllowed(state)</code> on the wrapped request object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/portlet/PortletRequest.html#isWindowStateAllowed(javax.portlet.WindowState)">isWindowStateAllowed</A></CODE> in interface <CODE><A HREF="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>state</CODE> - window state to checked
<DT><B>Returns:</B><DD>true, if it is valid for this portlet
             in this request to change to the
            given window state</DL>
</DD>
</DL>
<HR>

<A NAME="removeAttribute(java.lang.String)"><!-- --></A><H3>
removeAttribute</H3>
<PRE>
public void <B>removeAttribute</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>The default behavior of this method is to call 
 <code>removeAttribute(name)</code> on the wrapped request object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/portlet/PortletRequest.html#removeAttribute(java.lang.String)">removeAttribute</A></CODE> in interface <CODE><A HREF="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - a <code>String</code> specifying 
                                        the name of the attribute to be removed</DL>
</DD>
</DL>
<HR>

<A NAME="setAttribute(java.lang.String, java.lang.Object)"><!-- --></A><H3>
setAttribute</H3>
<PRE>
public void <B>setAttribute</B>(java.lang.String&nbsp;name,
                         java.lang.Object&nbsp;o)</PRE>
<DL>
<DD>The default behavior of this method is to call 
 <code>setAttribute(name, o)</code> on the wrapped request object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/portlet/PortletRequest.html#setAttribute(java.lang.String, java.lang.Object)">setAttribute</A></CODE> in interface <CODE><A HREF="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - a <code>String</code> specifying 
                                        the name of the attribute<DD><CODE>o</CODE> - the <code>Object</code> to be stored</DL>
</DD>
</DL>
<HR>

<A NAME="getRequest()"><!-- --></A><H3>
getRequest</H3>
<PRE>
public <A HREF="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</A> <B>getRequest</B>()</PRE>
<DL>
<DD>Return the wrapped request object.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the wrapped request</DL>
</DD>
</DL>
<HR>

<A NAME="setRequest(javax.portlet.PortletRequest)"><!-- --></A><H3>
setRequest</H3>
<PRE>
public void <B>setRequest</B>(<A HREF="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</A>&nbsp;request)</PRE>
<DL>
<DD>Sets the request object being wrapped.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the request to set
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the request is null.</DL>
</DD>
</DL>
<HR>

<A NAME="getCookies()"><!-- --></A><H3>
getCookies</H3>
<PRE>
public javax.servlet.http.Cookie[] <B>getCookies</B>()</PRE>
<DL>
<DD>The default behavior of this method is to call 
 <code>getCookies()</code> on the wrapped request object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/portlet/PortletRequest.html#getCookies()">getCookies</A></CODE> in interface <CODE><A HREF="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>array of cookie properties, or 
          <code>null</code> if no cookies exist.<DT><B>See Also:</B><DD><A HREF="../../../javax/portlet/PortletResponse.html#addProperty(javax.servlet.http.Cookie)"><CODE>PortletResponse.addProperty(Cookie)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getPrivateParameterMap()"><!-- --></A><H3>
getPrivateParameterMap</H3>
<PRE>
public java.util.Map&lt;java.lang.String,java.lang.String[]&gt; <B>getPrivateParameterMap</B>()</PRE>
<DL>
<DD>The default behavior of this method is to call 
 <code>getPrivateParameterMap()</code> on the wrapped request object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/portlet/PortletRequest.html#getPrivateParameterMap()">getPrivateParameterMap</A></CODE> in interface <CODE><A HREF="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an immutable <code>Map</code> containing private parameter names as 
             keys and private parameter values as map values, or an empty <code>Map</code>
             if no private parameters exist. The keys in the parameter
             map are of type String. The values in the parameter map are of type
             String array (<code>String[]</code>).</DL>
</DD>
</DL>
<HR>

<A NAME="getPublicParameterMap()"><!-- --></A><H3>
getPublicParameterMap</H3>
<PRE>
public java.util.Map&lt;java.lang.String,java.lang.String[]&gt; <B>getPublicParameterMap</B>()</PRE>
<DL>
<DD>The default behavior of this method is to call 
 <code>getPublicParameterMap()</code> on the wrapped request object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/portlet/PortletRequest.html#getPublicParameterMap()">getPublicParameterMap</A></CODE> in interface <CODE><A HREF="../../../javax/portlet/PortletRequest.html" title="interface in javax.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an immutable <code>Map</code> containing public parameter names as 
             keys and public parameter values as map values, or an empty <code>Map</code>
             if no public parameters exist. The keys in the parameter
             map are of type String. The values in the parameter map are of type
             String array (<code>String[]</code>).</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF