portletrequest.html.svn-base

portal越来越流行了

 defined for a particular user, then for that user the attribute 
 exists in the returned map and the attribute has a <code>null</code> value.
 <p>
 If the user-attribute is not defined for the current user it
 will not show up in the Map.
 <p>
 The value is <code>javax.portlet.userinfo</code>.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortletRequest.USER_INFO">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="CCPP_PROFILE"><!-- --></A><H3>
CCPP_PROFILE</H3>
<PRE>
static final java.lang.String <B>CCPP_PROFILE</B></PRE>
<DL>
<DD>Used to retrieve an instance of the <code>javax.ccpp.Profile</code>
 with the <code>getAttribute</code> call. The returned profile is based
 on the current portlet request and may contain additional CC/PP 
 information set by the portal / portlet container.   
 <p>
 The value is <code>javax.portlet.ccpp</code>.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0</DD>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortletRequest.CCPP_PROFILE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="BASIC_AUTH"><!-- --></A><H3>
BASIC_AUTH</H3>
<PRE>
static final java.lang.String <B>BASIC_AUTH</B></PRE>
<DL>
<DD>String identifier for Basic authentication. Value "BASIC".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortletRequest.BASIC_AUTH">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="FORM_AUTH"><!-- --></A><H3>
FORM_AUTH</H3>
<PRE>
static final java.lang.String <B>FORM_AUTH</B></PRE>
<DL>
<DD>String identifier for Form based authentication. Value "FORM".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortletRequest.FORM_AUTH">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="CLIENT_CERT_AUTH"><!-- --></A><H3>
CLIENT_CERT_AUTH</H3>
<PRE>
static final java.lang.String <B>CLIENT_CERT_AUTH</B></PRE>
<DL>
<DD>String identifier for Certification based authentication. Value "CLIENT_CERT".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortletRequest.CLIENT_CERT_AUTH">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="DIGEST_AUTH"><!-- --></A><H3>
DIGEST_AUTH</H3>
<PRE>
static final java.lang.String <B>DIGEST_AUTH</B></PRE>
<DL>
<DD>String identifier for Digest based authentication. Value "DIGEST".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortletRequest.DIGEST_AUTH">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ACTION_PHASE"><!-- --></A><H3>
ACTION_PHASE</H3>
<PRE>
static final java.lang.String <B>ACTION_PHASE</B></PRE>
<DL>
<DD>String identifier for the portlet action lifecycle phase. In this
 phase the portlet request and response are from type
 <code>ActionRequest</code> and <code>ActionResponse</code>.
 <p>
 The value of the constant is <code>ACTION_PHASE</code>.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0</DD>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortletRequest.ACTION_PHASE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="EVENT_PHASE"><!-- --></A><H3>
EVENT_PHASE</H3>
<PRE>
static final java.lang.String <B>EVENT_PHASE</B></PRE>
<DL>
<DD>String identifier for the portlet event lifecycle phase. In this
 phase the portlet request and response are from type
 <code>EventRequest</code> and <code>EventResponse</code>.
 <p>
 The value of the constant is <code>EVENT_PHASE</code>.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0</DD>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortletRequest.EVENT_PHASE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="RENDER_PHASE"><!-- --></A><H3>
RENDER_PHASE</H3>
<PRE>
static final java.lang.String <B>RENDER_PHASE</B></PRE>
<DL>
<DD>String identifier for the portlet render lifecycle phase. In this
 phase the portlet request and response are from type
 <code>RenderRequest</code> and <code>RenderResponse</code>.
 <p>
 The value of the constant is <code>RENDER_PHASE</code>.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0</DD>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortletRequest.RENDER_PHASE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="RESOURCE_PHASE"><!-- --></A><H3>
RESOURCE_PHASE</H3>
<PRE>
static final java.lang.String <B>RESOURCE_PHASE</B></PRE>
<DL>
<DD>String identifier for the portlet resource serving lifecycle phase. In this
 phase the portlet request and response are from type
 <code>ResourceRequest</code> and <code>ResourceResponse</code>.
 <p>
 The value of the constant is <code>RESOURCE_PHASE</code>.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0</DD>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortletRequest.RESOURCE_PHASE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="LIFECYCLE_PHASE"><!-- --></A><H3>
LIFECYCLE_PHASE</H3>
<PRE>
static final java.lang.String <B>LIFECYCLE_PHASE</B></PRE>
<DL>
<DD>Provides the portlet lifecycle phase of the current request
 as request attribute.
 <p>
 Valid values are: ACTION_PHASE, EVENT_PHASE, RENDER_PHASE,
 RESOURCE_SERVING_PHASE.
 <p>
 The value of the constant is <code>javax.portlet.lifecylce_phase</code>.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0</DD>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortletRequest.LIFECYCLE_PHASE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="RENDER_PART"><!-- --></A><H3>
RENDER_PART</H3>
<PRE>
static final java.lang.String <B>RENDER_PART</B></PRE>
<DL>
<DD>The RENDER_PART portlet request attribute is set by portals
 that are streaming based and therefore need to split the
 render phase into two parts: first the RENDER_HEADERS part
 where the portlet should only set the header related data
 and the portlet title, and second the RENDER_MARKUP part
 in which the portlet should produce its markup.
 <p>
 Non-streaming portals will not set this attribute and thus
 the portlet should set headers, portlet title and produce
 its markup in a single render request.
 <p>
 The value of the constant is <code>javax.portlet.render_part</code>.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0</DD>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortletRequest.RENDER_PART">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="RENDER_HEADERS"><!-- --></A><H3>
RENDER_HEADERS</H3>
<PRE>
static final java.lang.String <B>RENDER_HEADERS</B></PRE>
<DL>
<DD>The RENDER_HEADERS is a possible value of the RENDER_PART
 request attribute and denotes that the portlet should set
 the intended headers and the portlet title of this render
 request.
 <p>
 The value of the constant is <code>RENDER_HEADERS</code>.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0</DD>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortletRequest.RENDER_HEADERS">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="RENDER_MARKUP"><!-- --></A><H3>
RENDER_MARKUP</H3>
<PRE>
static final java.lang.String <B>RENDER_MARKUP</B></PRE>
<DL>
<DD>The RENDER_MARKUP is a possible value of the RENDER_PART
 request attribute and denotes that the portlet should
 produce its markup for this render request.
 <p>
 The value of the constant is <code>RENDER_MARKUP</code>.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0</DD>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortletRequest.RENDER_MARKUP">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ACTION_SCOPE_ID"><!-- --></A><H3>
ACTION_SCOPE_ID</H3>
<PRE>
static final java.lang.String <B>ACTION_SCOPE_ID</B></PRE>
<DL>
<DD>The action scope ID that the portlet container uses
 for storing the current action scope as render parameter
 if the <code>javax.portlet.actionScopedRequestAttributes</code>
 container runtime option is used by the portlet.
 <p>
 The value is <code>javax.portlet.as</code>.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0</DD>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#javax.portlet.PortletRequest.ACTION_SCOPE_ID">Constant Field Values</A></DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="isWindowStateAllowed(javax.portlet.WindowState)"><!-- --></A><H3>
isWindowStateAllowed</H3>
<PRE>
boolean <B>isWindowStateAllowed</B>(<A HREF="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</A>&nbsp;state)</PRE>
<DL>
<DD>Returns true, if the given window state is valid
 to be set for this portlet in the context
 of the current request.
<P>
<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="isPortletModeAllowed(javax.portlet.PortletMode)"><!-- --></A><H3>
isPortletModeAllowed</H3>
<PRE>
boolean <B>isPortletModeAllowed</B>(<A HREF="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</A>&nbsp;mode)</PRE>
<DL>
<DD>Returns true, if the given portlet mode is a valid
 one to set for this portlet  in the context
 of the current request.
<P>
<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="getPortletMode()"><!-- --></A><H3>
getPortletMode</H3>
<PRE>
<A HREF="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</A> <B>getPortletMode</B>()</PRE>
<DL>
<DD>Returns the current portlet mode of the portlet.
<P>
<DD><DL>

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

<A NAME="getWindowState()"><!-- --></A><H3>
getWindowState</H3>
<PRE>
<A HREF="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</A> <B>getWindowState</B>()</PRE>
<DL>
<DD>Returns the current window state of the portlet.
<P>
<DD><DL>

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