portalurlwriter.html

门户开发

<A NAME="writePortletRenderURL(java.io.Writer, java.lang.String, java.lang.String, java.util.Locale)"><!-- --></A><H3>
writePortletRenderURL</H3>
<PRE>
public java.io.Writer <B>writePortletRenderURL</B>(java.io.Writer&nbsp;writer,
                                            java.lang.String&nbsp;contentNode,
                                            java.lang.String&nbsp;portletWindow,
                                            java.util.Locale&nbsp;newLocale)
                                     throws java.io.IOException</PRE>
<DL>
<DD>Creates a render URL that points to the specified portlet window with the given locale.
 <p>
 The current render parameters of all portlets and the current state is preserved.
 </p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>writer</CODE> - Destination stream that receives the character representation of 
                              the URL (must not be null)<DD><CODE>contentNode</CODE> - Unique name of the content node the portlet window belongs to (must not be null).
                              The content node is needed in order to make the URL gneration operation less 
                              expensive.<DD><CODE>portletWindow</CODE> - Unique name of the target portlet window (must not be null)<DD><CODE>newLocale</CODE> - New locale (may be null)
<DT><B>Returns:</B><DD>Reference to the writer
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - - error occured on the underlying streams
<DD><CODE>java.lang.IllegalArgumentException</CODE> - - if <br>
                                  1. the given content node or portlet window is not valid or not accessible
                                  for the current user<br>
                                  2. the given locale is not supported</DL>
</DD>
</DL>
<HR>

<A NAME="writePortletRenderURL(java.io.Writer, com.ibm.portal.ObjectID, com.ibm.portal.ObjectID, javax.portlet.PortletMode, javax.portlet.WindowState, com.ibm.portal.portlet.service.url.Constants.PortalState, java.util.Map, java.util.Locale)"><!-- --></A><H3>
writePortletRenderURL</H3>
<PRE>
public java.io.Writer <B>writePortletRenderURL</B>(java.io.Writer&nbsp;writer,
                                            <A HREF="../../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;contentNode,
                                            <A HREF="../../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;portletWindow,
                                            javax.portlet.PortletMode&nbsp;newPortletMode,
                                            javax.portlet.WindowState&nbsp;newWindowState,
                                            <A HREF="../../../../../../com/ibm/portal/portlet/service/url/Constants.PortalState.html" title="interface in com.ibm.portal.portlet.service.url">Constants.PortalState</A>&nbsp;portalState,
                                            java.util.Map&nbsp;newRenderParameters,
                                            java.util.Locale&nbsp;newLocale)
                                     throws java.io.IOException,
                                            javax.portlet.PortletModeException,
                                            javax.portlet.WindowStateException</PRE>
<DL>
<DD>Creates a render URL that points to the specified portlet window.
 This method also allows to change different parts of the navigational state, like the portlet mode
 and window state of the targeted portlet, the portal state, the render parameters of the targeted
 portlet, and the locale.
 <p>
 If no new render parameters are specified the current render parameters of all portlets are preserved.
 If new render parameters for the target portlet are specified the render parameters of the target
 portlet are replaced with the specified render parameter and the render parameters of all other
 portlets are preserved.
 </p>
 <p>
 Note: Instead of providing <code>null</code> as values of please use one of the other flavors of this
 method. This will produce a better performace as the checking for <code>null</null> values can be omitted.
 </p>
 <p>
 TBD INSERT CODE SAMPLE HERE
 </p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>writer</CODE> - Destination stream that receives the character representation of 
                              the URL (must not be null)<DD><CODE>contentNode</CODE> - ObjectID of the content node the portlet window belongs to (must not be null).
                              The content node is needed in order to make the URL gneration operation less 
                              expensive.<DD><CODE>portletWindow</CODE> - ObjectID of the target portlet window (must not be null)<DD><CODE>newPortletMode</CODE> - New portlet mode of the target portlet (may be null)<DD><CODE>newWindowState</CODE> - New portlet window state of the target portlet (may be null)<DD><CODE>portalState</CODE> - New portal navigational state (e.g. SOLO mode or non-SOLO mode) (may be null)<DD><CODE>newRenderParameters</CODE> - New render parameters for the target portlet (may be null)<DD><CODE>newLocale</CODE> - New locale (may be null)
<DT><B>Returns:</B><DD>Reference to the writer
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - - error occured on the underlying streams
<DD><CODE>javax.portlet.PortletModeException</CODE> - -  if the target portlet cannot switch to this mode, 
                                 because the portal does not support this mode, the portlet has not 
                                 declared in its deployment descriptor that it supports this mode for 
                                 the current markup, or the current user is not allowed to switch to 
                                 this mode.
<DD><CODE>javax.portlet.WindowStateException</CODE> - -  if the portlet cannot switch to this state, because the portal does 
                                 not support this state, the portlet has not declared in its deployment
                                 descriptor that it supports this state, or the current user is not 
                                 allowed to switch to this state.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - - if <br>
                                  1. the given content node or portlet window is not valid or not accessible
                                  for the current user<br>
                                  2. the given portal state is not supported<br>
                                  3. the given locale is not supported</DL>
</DD>
</DL>
<HR>

<A NAME="writePortletRenderURL(java.io.Writer, com.ibm.portal.ObjectID, com.ibm.portal.ObjectID)"><!-- --></A><H3>
writePortletRenderURL</H3>
<PRE>
public java.io.Writer <B>writePortletRenderURL</B>(java.io.Writer&nbsp;writer,
                                            <A HREF="../../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;contentNode,
                                            <A HREF="../../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;portletWindow)
                                     throws java.io.IOException</PRE>
<DL>
<DD>Creates a render URL that points to the specified portlet window.
 <p>
 The current render parameters of all portlets and the current state is preserved.
 </p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>writer</CODE> - Destination stream that receives the character representation of 
                              the URL (must not be null)<DD><CODE>contentNode</CODE> - ObjectID of the content node the portlet window belongs to (must not be null).
                              The content node is needed in order to make the URL gneration operation less 
                              expensive.<DD><CODE>portletWindow</CODE> - ObjectID of the target portlet window (must not be null)
<DT><B>Returns:</B><DD>Reference to the writer
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - - error occured on the underlying streams
<DD><CODE>java.lang.IllegalArgumentException</CODE> - - if the given content node or portlet window is not 
                                  valid or not accessible</DL>
</DD>
</DL>
<HR>

<A NAME="writePortletRenderURL(java.io.Writer, com.ibm.portal.ObjectID, com.ibm.portal.ObjectID, javax.portlet.PortletMode)"><!-- --></A><H3>
writePortletRenderURL</H3>
<PRE>
public java.io.Writer <B>writePortletRenderURL</B>(java.io.Writer&nbsp;writer,
                                            <A HREF="../../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;contentNode,
                                            <A HREF="../../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;portletWindow,
                                            javax.portlet.PortletMode&nbsp;newPortletMode)
                                     throws java.io.IOException,
                                            javax.portlet.PortletModeException</PRE>
<DL>
<DD>Creates a render URL that points to the specified portlet window with the specified portlet mode.
 <p>
 The current render parameters of all portlets and the current state is preserved.
 </p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>writer</CODE> - Destination stream that receives the character representation of 
                              the URL (must not be null)<DD><CODE>contentNode</CODE> - ObjectID of the content node the portlet window belongs to (must not be null).
                              The content node is needed in order to make the URL gneration operation less 
                              expensive.<DD><CODE>portletWindow</CODE> - ObjectID of the target portlet window (must not be null)<DD><CODE>newPortletMode</CODE> - New portlet mode of the target portlet (must not be null)
<DT><B>Returns:</B><DD>Reference to the writer
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - - error occured on the underlying streams
<DD><CODE>javax.portlet.PortletModeException</CODE> - -  if the target portlet cannot switch to this mode, 
                                 because the portal does not support this mode, the portlet has not 
                                 declared in its deployment descriptor that it supports this mode for 
                                 the current markup, or the current user is not allowed to switch to 
                                 this mode.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - - if the given content node or portlet window is not 
                                  valid or not accessible</DL>
</DD>
</DL>
<HR>

<A NAME="writePortletRenderURL(java.io.Writer, com.ibm.portal.ObjectID, com.ibm.portal.ObjectID, javax.portlet.WindowState)"><!-- --></A><H3>
writePortletRenderURL</H3>
<PRE>
public java.io.Writer <B>writePortletRenderURL</B>(java.io.Writer&nbsp;writer,
                                            <A HREF="../../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;contentNode,
                                            <A HREF="../../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;portletWindow,
                                            javax.portlet.WindowState&nbsp;newWindowState)
                                     throws java.io.IOException,
                                            javax.portlet.WindowStateException</PRE>
<DL>
<DD>Creates a render URL that points to the specified portlet window with the new window state.
 <p>
 The current render parameters of all portlets and the current state is preserved.
 </p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>writer</CODE> - Destination stream that receives the character representation of 
                              the URL (must not be null)<DD><CODE>contentNode</CODE> - ObjectID of the content node the portlet window belongs to (must not be null).
                              The content node is needed in order to make the URL gneration operation less 
                              expensive.<DD><CODE>portletWindow</CODE> - ObjectID of the target portlet window (must not be null)<DD><CODE>newWindowState</CODE> - New portlet window state of the target portlet (must not be null)
<DT><B>Returns:</B><DD>Reference to the writer
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - - error occured on the underlying streams
<DD><CODE>javax.portlet.WindowStateException</CODE> - -  if the portlet cannot switch to this state, because the portal does 
                                 not support this state, the portlet has not declared in its deployment
                                 descriptor that it supports this state, or the current user is not 
                                 allowed to switch to this state.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - - if the given content node or portlet window is not valid
                                  or not accessible</DL>
</DD>
</DL>
<HR>

<A NAME="writePortletRenderURL(java.io.Writer, com.ibm.portal.ObjectID, com.ibm.portal.ObjectID, java.util.Map)"><!-- --></A><H3>
writePortletRenderURL</H3>
<PRE>
public java.io.Writer <B>writePortletRenderURL</B>(java.io.Writer&nbsp;writer,
                                            <A HREF="../../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;contentNode,
                                            <A HREF="../../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;portletWindow,
                                            java.util.Map&nbsp;newRenderParameters)
                                     throws java.io.IOException</PRE>
<DL>
<DD>Creates a render URL that points to the specified portlet window with the given render parameters.
 <p>
 The render parameters of the target portlet are replaced with the specified render parameter 
 and the render parameters of all other portlets and the portal state is preserved.
 </p>