portletrequestwrapper.html

门户开发

<PRE>
protected <A HREF="../../../../../../../com/ibm/wps/pe/pc/legacy/cmpf/ClientWrapper.html" title="class in com.ibm.wps.pe.pc.legacy.cmpf">ClientWrapper</A> <B>getClientWrapper</B>()</PRE>
<DL>
<DD>Use this method to return a wrapped client instead of the getClient method
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the wrapped client object.<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/jetspeed/portlet/Client.html" title="interface in org.apache.jetspeed.portlet"><CODE>Client</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getWindow()"><!-- --></A><H3>
getWindow</H3>
<PRE>
public <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletWindow.html" title="interface in org.apache.jetspeed.portlet">PortletWindow</A> <B>getWindow</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></B></DD>
<DD>Returns the window that the portlet is running in.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getWindow()">getWindow</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>

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

<A NAME="getData()"><!-- --></A><H3>
getData</H3>
<PRE>
public <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletData.html" title="interface in org.apache.jetspeed.portlet">PortletData</A> <B>getData</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></B></DD>
<DD>Returns the data of the concrete portlet instance
 <P>
 If the portlet is run in CONFIGURE mode, the
 portlet data is not accessible and this method will
 return <CODE>null</CODE>.
 </P>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getData()">getData</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>

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

<A NAME="getUser()"><!-- --></A><H3>
getUser</H3>
<PRE>
public <A HREF="../../../../../../../org/apache/jetspeed/portlet/User.html" title="interface in org.apache.jetspeed.portlet">User</A> <B>getUser</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></B></DD>
<DD>Returns the user object. The user object contains useful
 information about the user and his or her preferences.

 <P>
 If the user has not logged in or does not grant access to
 the portlet, this method returns <CODE>null</CODE>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getUser()">getUser</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the user object</DL>
</DD>
</DL>
<HR>

<A NAME="getPortletSession()"><!-- --></A><H3>
getPortletSession</H3>
<PRE>
public <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletSession.html" title="interface in org.apache.jetspeed.portlet">PortletSession</A> <B>getPortletSession</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></B></DD>
<DD>Returns the current session for the portlet or, if there is no current 
 portlet session, creates one and returns it.
 <P>
 This method should not be called when no portal session exists, i.e. when no user is
 logged in and the portlet is viewed on an anonymous page. In this case, the result may
 be a temporary session and session contents will be lost after the request completes.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getPortletSession()">getPortletSession</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>

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

<A NAME="getPortletSession(boolean)"><!-- --></A><H3>
getPortletSession</H3>
<PRE>
public <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletSession.html" title="interface in org.apache.jetspeed.portlet">PortletSession</A> <B>getPortletSession</B>(boolean&nbsp;create)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></B></DD>
<DD>Returns the current session for the portlet or, if there is no current 
 portlet session and the given flag is <CODE>true</CODE>, creates one and returns
 it.

 <P>
 If the given flag is <CODE>false</CODE> and there is no current session for the
 portal, this method returns <CODE>null</CODE>. If a session exists for the portal,
 but the portlet has not yet requested a session, a new portlet session will be 
 created.

 <P>
 This method should not be called with an argument value of <CODE>true</CODE> when no 
 portal session exists, i.e. when no user is
 logged in and the portlet is viewed on an anonymous page. In this case, the result may
 be a temporary session and session contents will be lost after the request completes.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getPortletSession(boolean)">getPortletSession</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>create</CODE> - <CODE>true</CODE> always return a portlet session, even if none exists and
             only a temporary session can be created.
          <CODE>false</CODE> return <CODE>null</CODE> if there is no current session
             for the portal. Never return a temporary session.
<DT><B>Returns:</B><DD>the portlet session</DL>
</DD>
</DL>
<HR>

<A NAME="getPortletSettings()"><!-- --></A><H3>
getPortletSettings</H3>
<PRE>
public <A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletSettings.html" title="interface in org.apache.jetspeed.portlet">PortletSettings</A> <B>getPortletSettings</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></B></DD>
<DD>Returns the <CODE>PortletSettings</CODE> object of the concrete portlet.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#getPortletSettings()">getPortletSettings</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the PortletSettings object, or NULL if no PortletSettings object is available.</DL>
</DD>
</DL>
<HR>

<A NAME="invalidateCache()"><!-- --></A><H3>
invalidateCache</H3>
<PRE>
public void <B>invalidateCache</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></B></DD>
<DD>Invalidates the cache for all window states, markups and locals
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html#invalidateCache()">invalidateCache</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A></CODE></DL>
</DD>
<DD><DL>
</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/wps/pe/pc/legacy/cmpf/PortletFilterAdapter.html" title="class in com.ibm.wps.pe.pc.legacy.cmpf"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../../com/ibm/wps/pe/pc/legacy/cmpf/PortletResponseWrapper.html" title="class in com.ibm.wps.pe.pc.legacy.cmpf"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PortletRequestWrapper.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;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&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>