stateawareresponse.html.svn-base

portal越来越流行了

setRenderParameters</H3>
<PRE>
void <B>setRenderParameters</B>(java.util.Map&lt;java.lang.String,java.lang.String[]&gt;&nbsp;parameters)</PRE>
<DL>
<DD>Sets a parameter map for the render request.
 <p>
 All previously set render parameters are cleared.
 <p>
 These parameters will be accessible in all sub-sequent render calls via
 the <code>PortletRequest.getParameter</code> call until a new request
 is targeted to the portlet.
 <p>
 The given parameters do not need to be encoded prior to calling this
 method.
 <p>
 The portlet should not modify the map any further after calling
 this method.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parameters</CODE> - Map containing parameter names for the render phase as keys
            and parameter values as map values. The keys in the parameter
            map must be of type String. The values in the parameter map
            must be of type String array (<code>String[]</code>).
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if parameters is <code>null</code>, if any of the
                keys in the Map are <code>null</code>, if any of
                the keys is not a String, or if any of the values is not a
                String array.
<DD><CODE>java.lang.IllegalStateException</CODE> - if the method is invoked after <code>sendRedirect</code>
                has been called.</DL>
</DD>
</DL>
<HR>

<A NAME="setRenderParameter(java.lang.String, java.lang.String)"><!-- --></A><H3>
setRenderParameter</H3>
<PRE>
void <B>setRenderParameter</B>(java.lang.String&nbsp;key,
                        java.lang.String&nbsp;value)</PRE>
<DL>
<DD>Sets a String parameter for the render request.
 <p>
 These parameters will be accessible in all sub-sequent render calls via
 the <code>PortletRequest.getParameter</code> call until a request is
 targeted to the portlet.
 <p>
 This method replaces all parameters with the given key.
 <p>
 The given parameter do not need to be encoded prior to calling this
 method.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - key of the render parameter<DD><CODE>value</CODE> - value of the render parameter
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if key is <code>null</code>.
<DD><CODE>java.lang.IllegalStateException</CODE> - if the method is invoked after <code>sendRedirect</code>
                has been called.</DL>
</DD>
</DL>
<HR>

<A NAME="setRenderParameter(java.lang.String, java.lang.String[])"><!-- --></A><H3>
setRenderParameter</H3>
<PRE>
void <B>setRenderParameter</B>(java.lang.String&nbsp;key,
                        java.lang.String[]&nbsp;values)</PRE>
<DL>
<DD>Sets a String array parameter for the render request.
 <p>
 These parameters will be accessible in all sub-sequent render calls via
 the <code>PortletRequest.getParameter</code> call until a request is
 targeted to the portlet.
 <p>
 This method replaces all parameters with the given key.
 <p>
 The given parameter do not need to be encoded prior to calling this
 method.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - key of the render parameter<DD><CODE>values</CODE> - values of the render parameter
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if key or value are <code>null</code>.
<DD><CODE>java.lang.IllegalStateException</CODE> - if the method is invoked after <code>sendRedirect</code>
                has been called.</DL>
</DD>
</DL>
<HR>

<A NAME="setEvent(javax.xml.namespace.QName, java.io.Serializable)"><!-- --></A><H3>
setEvent</H3>
<PRE>
void <B>setEvent</B>(javax.xml.namespace.QName&nbsp;name,
              java.io.Serializable&nbsp;value)</PRE>
<DL>
<DD>Publishes an Event with the given payload.
 <p>
 The object type of the value must be compliant with the specified event
 type in the portlet deployment descriptor.
 <p>
 The value must have a valid JAXB binding and be serializable.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the event name to publish, must not be <code>null</code><DD><CODE>value</CODE> - the value of this event, must have a valid JAXB binding and 
            be serializable, or <code>null</code>.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>, the value is not
                serializable, the value does not have a valid JAXB binding, the
                object type of the value is not the same as specified in
                the portlet deployment descriptor for this event name.<DT><B>Since:</B></DT>
  <DD>2.0</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="setEvent(java.lang.String, java.io.Serializable)"><!-- --></A><H3>
setEvent</H3>
<PRE>
void <B>setEvent</B>(java.lang.String&nbsp;name,
              java.io.Serializable&nbsp;value)</PRE>
<DL>
<DD>Publishes an Event with the given payload in the default namespace.
 <p>
 The name is treated as local part of the event QName and the namespace
 is either taken from the <code>default-event-namespace</code> element
 in the portlet deployment descriptor, or if this element is not provided
 the XML default namespace XMLConstants.NULL_NS_URI is used.
 <p>
 The object type of the value must be compliant with the specified event
 type in the portlet deployment descriptor.
 <p>
 The value must have a valid JAXB binding and be serializable.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the local part of the event name to publish, must not be <code>null</code><DD><CODE>value</CODE> - the value of this event, must have a valid JAXB binding and 
            be serializable, or <code>null</code>.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>, the value is not
                serializable, the value does not have a valid JAXB binding, the
                object type of the value is not the same as specified in
                the portlet deployment descriptor for this event name.<DT><B>Since:</B></DT>
  <DD>2.0</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getRenderParameterMap()"><!-- --></A><H3>
getRenderParameterMap</H3>
<PRE>
java.util.Map&lt;java.lang.String,java.lang.String[]&gt; <B>getRenderParameterMap</B>()</PRE>
<DL>
<DD>Returns a <code>Map</code> of the render parameters currently set on
 this response.
 <p>
 The values in the returned <code>Map</code> are from type String array (<code>String[]</code>).
 <p>
 If no parameters exist this method returns an empty <code>Map</code>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD><code>Map</code> containing render parameter names as keys and
         parameter values as map values, or an empty <code>Map</code> if
         no 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>).<DT><B>Since:</B></DT>
  <DD>2.0</DD>
</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 currently set portlet mode on this reponse.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the portlet mode, or <code>null</code> if none is set<DT><B>Since:</B></DT>
  <DD>2.0</DD>
</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 currently set window state on this response.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the window state, or <code>null</code> if none is set<DT><B>Since:</B></DT>
  <DD>2.0</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="removePublicRenderParameter(java.lang.String)"><!-- --></A><H3>
removePublicRenderParameter</H3>
<PRE>
void <B>removePublicRenderParameter</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Removes the specified public render parameter.
 The name must reference a public render parameter defined
 in the portlet deployment descriptor under the
 <code>public-render-parameter</code> element with the
 <code>identifier</code> mapping to the parameter name.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - a <code>String</code> specifying 
                                        the name of the public render parameter to be removed
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.<DT><B>Since:</B></DT>
  <DD>2.0</DD>
</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="class-use/StateAwareResponse.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../javax/portlet/ResourceURL.html" title="interface in javax.portlet"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../javax/portlet/UnavailableException.html" title="class in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../index.html?javax/portlet/StateAwareResponse.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="StateAwareResponse.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>