portletapiutils.html

门户开发

<A NAME="createPortletURI(java.lang.Object, int)"><!-- --></A><H3>
createPortletURI</H3>
<PRE>
public abstract java.lang.Object <B>createPortletURI</B>(java.lang.Object&nbsp;response,
                                                  int&nbsp;urlType)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>Creates a PortletURI for the given response. This method can only be called
 in the render phase of portal. The Portlet URI should be casted to the
 appropriate PortletURI class of the current Portal container.
 The response object must be a valid PortletResponse object to create the URL.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>response</CODE> - A PortletResponse<DD><CODE>urlType</CODE> - the type of URL, typically standard, or return
<DT><B>Returns:</B><DD>Object the portlet URL, can be <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="createPortletURI(java.lang.Object, com.ibm.portal.struts.common.PortletURIAttributes)"><!-- --></A><H3>
createPortletURI</H3>
<PRE>
public abstract java.lang.Object <B>createPortletURI</B>(java.lang.Object&nbsp;response,
                                                  <A HREF="../../../../../com/ibm/portal/struts/common/PortletURIAttributes.html" title="class in com.ibm.portal.struts.common">PortletURIAttributes</A>&nbsp;uriAttributes)</PRE>
<DL>
<DD>Creates a PortletURI for the given response. This method can only be called
 in the render phase of portal. 
 The Portlet URI should be casted to the
 appropriate PortletURI class of the current Portal container.
 The response object must be a valid PortletResponse object to create the URL.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>response</CODE> - the portlet response object<DD><CODE>uriAttributes</CODE> - the URI attributes
<DT><B>Returns:</B><DD>object the portlet URI, can be <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="createPortletURIWithStrutsURL(java.lang.Object, java.lang.String)"><!-- --></A><H3>
createPortletURIWithStrutsURL</H3>
<PRE>
public java.lang.Object <B>createPortletURIWithStrutsURL</B>(java.lang.Object&nbsp;response,
                                                      java.lang.String&nbsp;actionUrl)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>Creates a Struts PortletURI for the given response and URL. Creates a 
 DefaultPortletAction and adds the Struts action URL as a parameter. 
 The response object must be a valid PortletResponse object to create the URL.
 The PortletURI should be casted to the
 appropriate PortletURI class of the current portal container.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>response</CODE> - the response object<DD><CODE>actionUrl</CODE> - the Struts action Url
<DT><B>Returns:</B><DD>Object portlet url, can return <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="createPortletURIWithStrutsURL(javax.servlet.http.HttpServletRequest, java.lang.String)"><!-- --></A><H3>
createPortletURIWithStrutsURL</H3>
<PRE>
public java.lang.Object <B>createPortletURIWithStrutsURL</B>(javax.servlet.http.HttpServletRequest&nbsp;request,
                                                      java.lang.String&nbsp;actionUrl)</PRE>
<DL>
<DD>Creates a Struts PortletURI for the given response and URL. Creates a DefaultPortletAction 
 and adds the Struts action URL as a parameter. 
 The return value can be <code>null</code>, if the response object cannot be found.
 The PortletURI should be casted to the
 appropriate PortletURI class of the current portal container.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the request object<DD><CODE>actionUrl</CODE> - the Struts action Url
<DT><B>Returns:</B><DD>Object portlet url, can return <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="createPortletURIWithStrutsURL(java.lang.Object, java.lang.String, int)"><!-- --></A><H3>
createPortletURIWithStrutsURL</H3>
<PRE>
public abstract java.lang.Object <B>createPortletURIWithStrutsURL</B>(java.lang.Object&nbsp;response,
                                                               java.lang.String&nbsp;actionUrl,
                                                               int&nbsp;urlType)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>Creates the requested type of PortletURI for the given response and URL. Creates a 
 DefaultPortletAction and adds the Struts action URL as a parameter.
 The response object must be a valid PortletResponse object to create the URL.
 The PortletURI should be casted to the
 appropriate PortletURI class of the current portal container.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>response</CODE> - A PortletResponse<DD><CODE>actionUrl</CODE> - the Struts action Url<DD><CODE>urlType</CODE> - the type of URL to create
<DT><B>Returns:</B><DD>Object the portlet URL, can return <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="createPortletURIWithStrutsURL(javax.servlet.http.HttpServletRequest, java.lang.String, int)"><!-- --></A><H3>
createPortletURIWithStrutsURL</H3>
<PRE>
public abstract java.lang.Object <B>createPortletURIWithStrutsURL</B>(javax.servlet.http.HttpServletRequest&nbsp;request,
                                                               java.lang.String&nbsp;actionUrl,
                                                               int&nbsp;urlType)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>Creates the requested type of PortletURI for the given response and URL. Creates a 
 DefaultPortletAction and adds the Struts action URL as a parameter.
 The return value can be <code>null</code>, if the response object cannot be found.
 The PortletURI should be casted to the
 appropriate PortletURI class of the current portal container.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the HttpServletRequest object<DD><CODE>actionUrl</CODE> - the Struts action Url<DD><CODE>urlType</CODE> - the type of URL to create
<DT><B>Returns:</B><DD>Object portlet URI, can return <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="createPortletURIWithStrutsURL(javax.servlet.http.HttpServletRequest, java.lang.String, com.ibm.portal.struts.common.PortletURIAttributes)"><!-- --></A><H3>
createPortletURIWithStrutsURL</H3>
<PRE>
public abstract java.lang.Object <B>createPortletURIWithStrutsURL</B>(javax.servlet.http.HttpServletRequest&nbsp;request,
                                                               java.lang.String&nbsp;actionUrl,
                                                               <A HREF="../../../../../com/ibm/portal/struts/common/PortletURIAttributes.html" title="class in com.ibm.portal.struts.common">PortletURIAttributes</A>&nbsp;uriAttributes)</PRE>
<DL>
<DD>Creates the requested type of PortletURI for the given response and URL. Creates 
 a DefaultPortletAction and adds the Struts action URL as a parameter.
 The return value can be <code>null</code>, if the response object cannot be found.
 The PortletURI should be casted to the
 appropriate PortletURI class of the current portal container.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the HttpServletRequest object<DD><CODE>actionUrl</CODE> - the Struts action Url<DD><CODE>uriAttributes</CODE> - the Portlet URI attributes
<DT><B>Returns:</B><DD>Object portlet URI, can return <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="createStrutsPortletURL(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, com.ibm.portal.struts.common.PortletURIAttributes)"><!-- --></A><H3>
createStrutsPortletURL</H3>
<PRE>
public abstract java.lang.Object <B>createStrutsPortletURL</B>(javax.servlet.http.HttpServletRequest&nbsp;request,
                                                        javax.servlet.http.HttpServletResponse&nbsp;response,
                                                        java.lang.String&nbsp;actionUrl,
                                                        <A HREF="../../../../../com/ibm/portal/struts/common/PortletURIAttributes.html" title="class in com.ibm.portal.struts.common">PortletURIAttributes</A>&nbsp;uriAttributes)</PRE>
<DL>
<DD>Creates the requested type of PortletURI for the given response and URL. Creates 
 a DefaultPortletAction and adds the Struts action URL as a parameter.
 The return value can be <code>null</code>, if the response object cannot be found.
 The Portlet URI should be casted to the
 appropriate PortletURI class of the current portal container.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the HttpServletRequest object<DD><CODE>response</CODE> - the HttpServletResponse object<DD><CODE>actionUrl</CODE> - the Struts action Url<DD><CODE>uriAttributes</CODE> - the PortletURI attributes
<DT><B>Returns:</B><DD>Object portlet URI, can return <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="typeOfURL(java.lang.String)"><!-- --></A><H3>
typeOfURL</H3>
<PRE>
public int <B>typeOfURL</B>(java.lang.String&nbsp;urlType)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>Returns the enumerated value for the URL type.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>urlType</CODE> - the url type
<DT><B>Returns:</B><DD>the url type, returns STANDARD_URL if type is not found<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/portal/struts/common/PortletURIAttributes.html" title="class in com.ibm.portal.struts.common"><CODE>PortletURIAttributes</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="addDefaultPortletAction(java.lang.Object)"><!-- --></A><H3>
addDefaultPortletAction</H3>
<PRE>
public abstract void <B>addDefaultPortletAction</B>(java.lang.Object&nbsp;portletURI)</PRE>
<DL>
<DD>Adds a portlet action to the given PortletURI. The name will be the value
 returned by getDefaultPortletActionName.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>portletURI</CODE> - previously created PorletURI</DL>
</DD>
</DL>
<HR>

<A NAME="addDefaultPortletAction(java.lang.Object, java.lang.String)"><!-- --></A><H3>
addDefaultPortletAction</H3>
<PRE>
public abstract void <B>addDefaultPortletAction</B>(java.lang.Object&nbsp;portletURI,
                                             java.lang.String&nbsp;key)</PRE>
<DL>
<DD>Adds a portlet action to the given PortletURI using the given key.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>portletURI</CODE> - previously created PorletURI<DD><CODE>key</CODE> - the key to add</DL>
</DD>
</DL>
<HR>

<A NAME="addStrutsActionUrlAsParameter(java.lang.Object, java.lang.String)"><!-- --></A><H3>
addStrutsActionUrlAsParameter</H3>
<PRE>
public abstract void <B>addStrutsActionUrlAsParameter</B>(java.lang.Object&nbsp;portletURI,
                                                   java.lang.String&nbsp;actionUrl)</PRE>
<DL>
<DD>Adds the Struts action URL as a parameter to the given PortletURI using the 
 value returned by getStrutsActionParameterName as the parameter name.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>portletURI</CODE> - previously created porletURI<DD><CODE>actionUrl</CODE> - action URL String to use</DL>
</DD>
</DL>
<HR>

<A NAME="addParameter(java.lang.Object, java.lang.String, java.lang.String)"><!-- --></A><H3>
addParameter</H3>
<PRE>
public abstract void <B>addParameter</B>(java.lang.Object&nbsp;portletURI,
                                  java.lang.String&nbsp;key,
                                  java.lang.String&nbsp;value)</PRE>
<DL>
<DD>Adds the parameter to the given PortletURI. The key will be used to look up
 the parameter name from getParameterName
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>portletURI</CODE> - previously created PorletURI<DD><CODE>key</CODE> - the parameter name<DD><CODE>value</CODE> - the parameter value</DL>
</DD>
</DL>
<HR>

<A NAME="forward(java.lang.String)"><!-- --></A><H3>
forward</H3>
<PRE>
public abstract void <B>forward</B>(java.lang.String&nbsp;uri)
                      throws javax.servlet.ServletException</PRE>
<DL>
<DD>Processes a forward. Portal does not support forwards, so this method is 
 an alternative to pageContext.forward. The URI can either be a Struts action
 or a URI that can be included. If this is not the case then a ServletException
 is thrown. If the request object cannot be found, then a ServletException is thrown.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - forward to the specified URI path
<DT><B>Throws:</B>
<DD><CODE>javax.servlet.ServletException</CODE> - if the forward is not successful</DL>
</DD>
</DL>
<HR>

<A NAME="forward(java.lang.String, javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
forward</H3>
<PRE>
public abstract void <B>forward</B>(java.lang.String&nbsp;uri,
                             javax.servlet.http.HttpServletRequest&nbsp;request)
                      throws javax.servlet.ServletException</PRE>
<DL>
<DD>Processes a forward. Portal does not support forwards, so this method is 
 an alternative to pageContext.forward. The URI can either be a Struts action
 or a URI that can be included. If this is not the case then a ServletException
 is thrown.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - forward to the URI path<DD><CODE>request</CODE> - the HttpServletRequest object
<DT><B>Throws:</B>
<DD><CODE>javax.servlet.ServletException</CODE> - if the forward is not successful</DL>
</DD>
</DL>
<HR>

<A NAME="encodeURL(java.lang.String, javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>