portalurlwriter.html

门户开发

<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>newRenderParameters</CODE> - New render parameters for the target portlet (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, com.ibm.portal.portlet.service.url.Constants.PortalState)"><!-- --></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,
                                            <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)
                                     throws java.io.IOException</PRE>
<DL>
<DD>Creates a render URL that points to the specified portlet window with the given portal state.
 <p>
 The current render parameters of all portlets are 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>portalState</CODE> - New portal navigational state (e.g. SOLO mode or non-SOLO mode) (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 portal state is not supported<br></DL>
</DD>
</DL>
<HR>

<A NAME="writePortletRenderURL(java.io.Writer, com.ibm.portal.ObjectID, com.ibm.portal.ObjectID, 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,
                                            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> - 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>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="writeContentNodeRenderURL(java.io.Writer, java.lang.String)"><!-- --></A><H3>
writeContentNodeRenderURL</H3>
<PRE>
public java.io.Writer <B>writeContentNodeRenderURL</B>(java.io.Writer&nbsp;writer,
                                                java.lang.String&nbsp;contentNode)
                                         throws java.io.IOException</PRE>
<DL>
<DD>Creates a render URL that points to the specified content node (e.g. portal page).
 <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).
<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 is not valid or not accessible
                                  for the current user<br></DL>
</DD>
</DL>
<HR>

<A NAME="writeContentNodeRenderURL(java.io.Writer, com.ibm.portal.ObjectID)"><!-- --></A><H3>
writeContentNodeRenderURL</H3>
<PRE>
public java.io.Writer <B>writeContentNodeRenderURL</B>(java.io.Writer&nbsp;writer,
                                                <A HREF="../../../../../../com/ibm/portal/ObjectID.html" title="interface in com.ibm.portal">ObjectID</A>&nbsp;contentNode)
                                         throws java.io.IOException</PRE>
<DL>
<DD>Creates a render URL that points to the specified content node (e.g. portal page).
 <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).
<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 is not valid or not accessible
                                  for the current user<br></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=3 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;<A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</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="../../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</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-all.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="../../../../../../com/ibm/portal/portlet/service/url/PortalURLGenerationService.html" title="interface in com.ibm.portal.portlet.service.url"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PortalURLWriter.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>