You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pluto-scm@portals.apache.org by es...@apache.org on 2008/05/17 02:57:33 UTC
svn commit: r657263 [3/9] - in
/portals/pluto/branches/pluto-1.1.x/src/site/resources: ./
portlet-1.0-apidocs/ portlet-1.0-apidocs/javax/
portlet-1.0-apidocs/javax/portlet/
Added: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/ActionRequest.html
URL: http://svn.apache.org/viewvc/portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/ActionRequest.html?rev=657263&view=auto
==============================================================================
--- portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/ActionRequest.html (added)
+++ portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/ActionRequest.html Fri May 16 17:57:32 2008
@@ -0,0 +1,363 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc on Mon Sep 08 18:33:40 CEST 2003 -->
+<TITLE>
+Portlet API (V1.0) : Interface ActionRequest
+</TITLE>
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
+</HEAD>
+<BODY BGCOLOR="white">
+
+<!-- ========== START OF NAVBAR ========== -->
+<A NAME="navbar_top"><!-- --></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Portlet API (V1.0) </EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ PREV CLASS
+ <A HREF="../../javax/portlet/ActionResponse.html"><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>
+ <A HREF="ActionRequest.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<!-- =========== END OF NAVBAR =========== -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+javax.portlet</FONT>
+<BR>
+Interface ActionRequest</H2>
+<DL>
+<DT><B>All Superinterfaces:</B> <DD><A HREF="../../javax/portlet/PortletRequest.html">PortletRequest</A></DD>
+</DL>
+<HR>
+<DL>
+<DT>public interface <B>ActionRequest</B><DT>extends <A HREF="../../javax/portlet/PortletRequest.html">PortletRequest</A></DL>
+
+<P>
+The <CODE>ActionRequest</CODE> represents the request sent to the portlet
+ to handle an action.
+ It extends the PortletRequest interface to provide action request
+ information to portlets.<br>
+ The portlet container creates an <CODE>ActionRequest</CODE> object and
+ passes it as argument to the portlet's <CODE>processAction</CODE> method.
+<P>
+<DL>
+<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/PortletRequest.html"><CODE>PortletRequest</CODE></A>,
+<A HREF="../../javax/portlet/RenderRequest.html"><CODE>RenderRequest</CODE></A></DL>
+<HR>
+
+<P>
+<!-- ======== INNER CLASS SUMMARY ======== -->
+
+
+<!-- =========== FIELD SUMMARY =========== -->
+
+<A NAME="fields_inherited_from_class_javax.portlet.PortletRequest"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TD><B>Fields inherited from interface javax.portlet.<A HREF="../../javax/portlet/PortletRequest.html">PortletRequest</A></B></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A HREF="../../javax/portlet/PortletRequest.html#BASIC_AUTH">BASIC_AUTH</A>, <A HREF="../../javax/portlet/PortletRequest.html#CLIENT_CERT_AUTH">CLIENT_CERT_AUTH</A>, <A HREF="../../javax/portlet/PortletRequest.html#DIGEST_AUTH">DIGEST_AUTH</A>, <A HREF="../../javax/portlet/PortletRequest.html#FORM_AUTH">FORM_AUTH</A>, <A HREF="../../javax/portlet/PortletRequest.html#USER_INFO">USER_INFO</A></CODE></TD>
+</TR>
+</TABLE>
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=2><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/ActionRequest.html#getCharacterEncoding()">getCharacterEncoding</A></B>()</CODE>
+
+<BR>
+ Returns the name of the character encoding used in the body of this request.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/ActionRequest.html#getContentLength()">getContentLength</A></B>()</CODE>
+
+<BR>
+ Returns the length, in bytes, of the request body
+ which is made available by the input stream, or -1 if the
+ length is not known.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/ActionRequest.html#getContentType()">getContentType</A></B>()</CODE>
+
+<BR>
+ Returns the MIME type of the body of the request,
+ or null if the type is not known.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.io.InputStream</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/ActionRequest.html#getPortletInputStream()">getPortletInputStream</A></B>()</CODE>
+
+<BR>
+ Retrieves the body of the HTTP request from client to
+ portal as binary data using
+ an <CODE>InputStream</CODE>.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.io.BufferedReader</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/ActionRequest.html#getReader()">getReader</A></B>()</CODE>
+
+<BR>
+ Retrieves the body of the HTTP request from the client to the portal
+ as character data using
+ a <code>BufferedReader</code>.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/ActionRequest.html#setCharacterEncoding(java.lang.String)">setCharacterEncoding</A></B>(java.lang.String enc)</CODE>
+
+<BR>
+ Overrides the name of the character encoding used in the body of this
+ request.</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_javax.portlet.PortletRequest"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TD><B>Methods inherited from interface javax.portlet.<A HREF="../../javax/portlet/PortletRequest.html">PortletRequest</A></B></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A HREF="../../javax/portlet/PortletRequest.html#getAttribute(java.lang.String)">getAttribute</A>, <A HREF="../../javax/portlet/PortletRequest.html#getAttributeNames()">getAttributeNames</A>, <A HREF="../../javax/portlet/PortletRequest.html#getAuthType()">getAuthType</A>, <A HREF="../../javax/portlet/PortletRequest.html#getContextPath()">getContextPath</A>, <A HREF="../../javax/portlet/PortletRequest.html#getLocale()">getLocale</A>, <A HREF="../../javax/portlet/PortletRequest.html#getLocales()">getLocales</A>, <A HREF="../../javax/portlet/PortletRequest.html#getParameter(java.lang.String)">getParameter</A>, <A HREF="../../javax/portlet/PortletRequest.html#getParameterMap()">getParameterMap</A>, <A HREF="../../javax/portlet/PortletRequest.html#getParameterNames()">getParameterNames</A>, <A HREF="../../javax/portlet/PortletRequest.html#getParameterValues(java.lang.String)">getParameterValues</A>, <A HREF="../../javax/portlet/PortletRequest.html#getPortalContext()">ge
tPortalContext</A>, <A HREF="../../javax/portlet/PortletRequest.html#getPortletMode()">getPortletMode</A>, <A HREF="../../javax/portlet/PortletRequest.html#getPortletSession()">getPortletSession</A>, <A HREF="../../javax/portlet/PortletRequest.html#getPortletSession(boolean)">getPortletSession</A>, <A HREF="../../javax/portlet/PortletRequest.html#getPreferences()">getPreferences</A>, <A HREF="../../javax/portlet/PortletRequest.html#getProperties(java.lang.String)">getProperties</A>, <A HREF="../../javax/portlet/PortletRequest.html#getProperty(java.lang.String)">getProperty</A>, <A HREF="../../javax/portlet/PortletRequest.html#getPropertyNames()">getPropertyNames</A>, <A HREF="../../javax/portlet/PortletRequest.html#getRemoteUser()">getRemoteUser</A>, <A HREF="../../javax/portlet/PortletRequest.html#getRequestedSessionId()">getRequestedSessionId</A>, <A HREF="../../javax/portlet/PortletRequest.html#getResponseContentType()">getResponseContentType</A>, <A HREF="../../javax/por
tlet/PortletRequest.html#getResponseContentTypes()">getResponseContentTypes</A>, <A HREF="../../javax/portlet/PortletRequest.html#getScheme()">getScheme</A>, <A HREF="../../javax/portlet/PortletRequest.html#getServerName()">getServerName</A>, <A HREF="../../javax/portlet/PortletRequest.html#getServerPort()">getServerPort</A>, <A HREF="../../javax/portlet/PortletRequest.html#getUserPrincipal()">getUserPrincipal</A>, <A HREF="../../javax/portlet/PortletRequest.html#getWindowState()">getWindowState</A>, <A HREF="../../javax/portlet/PortletRequest.html#isPortletModeAllowed(javax.portlet.PortletMode)">isPortletModeAllowed</A>, <A HREF="../../javax/portlet/PortletRequest.html#isRequestedSessionIdValid()">isRequestedSessionIdValid</A>, <A HREF="../../javax/portlet/PortletRequest.html#isSecure()">isSecure</A>, <A HREF="../../javax/portlet/PortletRequest.html#isUserInRole(java.lang.String)">isUserInRole</A>, <A HREF="../../javax/portlet/PortletRequest.html#isWindowStateAllowed(javax.
portlet.WindowState)">isWindowStateAllowed</A>, <A HREF="../../javax/portlet/PortletRequest.html#removeAttribute(java.lang.String)">removeAttribute</A>, <A HREF="../../javax/portlet/PortletRequest.html#setAttribute(java.lang.String, java.lang.Object)">setAttribute</A></CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=1><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TD>
+</TR>
+</TABLE>
+
+<A NAME="getPortletInputStream()"><!-- --></A><H3>
+getPortletInputStream</H3>
+<PRE>
+public java.io.InputStream <B>getPortletInputStream</B>()
+ throws java.io.IOException</PRE>
+<DL>
+<DD>Retrieves the body of the HTTP request from client to
+ portal as binary data using
+ an <CODE>InputStream</CODE>. Either this method or
+ <A HREF="../../javax/portlet/ActionRequest.html#getReader()"><CODE>getReader()</CODE></A> may be called to read the body, but not both.
+ <p>
+ For HTTP POST data of type application/x-www-form-urlencoded
+ this method throws an <code>IllegalStateException</code>
+ as this data has been already processed by the
+ portal/portlet-container and is available as request parameters.<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Returns:</B><DD>an input stream containing the body of the request<DT><B>Throws:</B><DD><CODE>java.lang.IllegalStateException</CODE> - if getReader was already called, or it is a
+ HTTP POST data of type application/x-www-form-urlencoded<DD><CODE>java.io.IOException</CODE> - if an input or output exception occurred</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setCharacterEncoding(java.lang.String)"><!-- --></A><H3>
+setCharacterEncoding</H3>
+<PRE>
+public void <B>setCharacterEncoding</B>(java.lang.String enc)
+ throws java.io.UnsupportedEncodingException</PRE>
+<DL>
+<DD>Overrides the name of the character encoding used in the body of this
+ request. This method must be called prior to reading input
+ using <A HREF="../../javax/portlet/ActionRequest.html#getReader()"><CODE>getReader()</CODE></A> or <A HREF="../../javax/portlet/ActionRequest.html#getPortletInputStream()"><CODE>getPortletInputStream()</CODE></A>.
+ <p>
+ This method only sets the character set for the Reader that the
+ <A HREF="../../javax/portlet/ActionRequest.html#getReader()"><CODE>getReader()</CODE></A> method returns.<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>enc</CODE> - a <code>String</code> containing the name of
+ the chararacter encoding.<DT><B>Throws:</B><DD><CODE>java.io.UnsupportedEncodingException</CODE> - if this is not a valid encoding<DD><CODE>java.lang.IllegalStateException</CODE> - if this method is called after
+ reading request parameters or reading input using
+ <code>getReader()</code></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getReader()"><!-- --></A><H3>
+getReader</H3>
+<PRE>
+public java.io.BufferedReader <B>getReader</B>()
+ throws java.io.UnsupportedEncodingException,
+ java.io.IOException</PRE>
+<DL>
+<DD>Retrieves the body of the HTTP request from the client to the portal
+ as character data using
+ a <code>BufferedReader</code>. The reader translates the character
+ data according to the character encoding used on the body.
+ Either this method or <A HREF="../../javax/portlet/ActionRequest.html#getPortletInputStream()"><CODE>getPortletInputStream()</CODE></A> may be called to read the
+ body, not both.
+ <p>
+ For HTTP POST data of type application/x-www-form-urlencoded
+ this method throws an <code>IllegalStateException</code>
+ as this data has been already processed by the
+ portal/portlet-container and is available as request parameters.<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Returns:</B><DD>a <code>BufferedReader</code>
+ containing the body of the request<DT><B>Throws:</B><DD><CODE>java.io.UnsupportedEncodingException</CODE> - if the character set encoding used is
+ not supported and the text cannot be decoded<DD><CODE>java.lang.IllegalStateException</CODE> - if <A HREF="../../javax/portlet/ActionRequest.html#getPortletInputStream()"><CODE>getPortletInputStream()</CODE></A> method
+ has been called on this request, it is a
+ HTTP POST data of type application/x-www-form-urlencoded.<DD><CODE>java.io.IOException</CODE> - if an input or output exception occurred<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/ActionRequest.html#getPortletInputStream()"><CODE>getPortletInputStream()</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getCharacterEncoding()"><!-- --></A><H3>
+getCharacterEncoding</H3>
+<PRE>
+public java.lang.String <B>getCharacterEncoding</B>()</PRE>
+<DL>
+<DD>Returns the name of the character encoding used in the body of this request.
+ This method returns <code>null</code> if the request
+ does not specify a character encoding.<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Returns:</B><DD>a <code>String</code> containing the name of
+ the chararacter encoding, or <code>null</code>
+ if the request does not specify a character encoding.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getContentType()"><!-- --></A><H3>
+getContentType</H3>
+<PRE>
+public java.lang.String <B>getContentType</B>()</PRE>
+<DL>
+<DD>Returns the MIME type of the body of the request,
+ or null if the type is not known.<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Returns:</B><DD>a <code>String</code> containing the name
+ of the MIME type of the request, or null
+ if the type is not known.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getContentLength()"><!-- --></A><H3>
+getContentLength</H3>
+<PRE>
+public int <B>getContentLength</B>()</PRE>
+<DL>
+<DD>Returns the length, in bytes, of the request body
+ which is made available by the input stream, or -1 if the
+ length is not known.<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Returns:</B><DD>an integer containing the length of the
+ request body or -1 if the length is not known</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+<!-- ========== START OF NAVBAR ========== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Portlet API (V1.0) </EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ PREV CLASS
+ <A HREF="../../javax/portlet/ActionResponse.html"><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>
+ <A HREF="ActionRequest.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<!-- =========== END OF NAVBAR =========== -->
+
+<HR>
+<a href=license.txt >Copyright</a> © 2003 IBM Corporation and Sun Microsystems, Inc. All rights reserved
+</BODY>
+</HTML>
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/ActionRequest.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/ActionRequest.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/ActionResponse.html
URL: http://svn.apache.org/viewvc/portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/ActionResponse.html?rev=657263&view=auto
==============================================================================
--- portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/ActionResponse.html (added)
+++ portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/ActionResponse.html Fri May 16 17:57:32 2008
@@ -0,0 +1,395 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc on Mon Sep 08 18:33:40 CEST 2003 -->
+<TITLE>
+Portlet API (V1.0) : Interface ActionResponse
+</TITLE>
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
+</HEAD>
+<BODY BGCOLOR="white">
+
+<!-- ========== START OF NAVBAR ========== -->
+<A NAME="navbar_top"><!-- --></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Portlet API (V1.0) </EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/ActionRequest.html"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/PortalContext.html"><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>
+ <A HREF="ActionResponse.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<!-- =========== END OF NAVBAR =========== -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+javax.portlet</FONT>
+<BR>
+Interface ActionResponse</H2>
+<DL>
+<DT><B>All Superinterfaces:</B> <DD><A HREF="../../javax/portlet/PortletResponse.html">PortletResponse</A></DD>
+</DL>
+<HR>
+<DL>
+<DT>public interface <B>ActionResponse</B><DT>extends <A HREF="../../javax/portlet/PortletResponse.html">PortletResponse</A></DL>
+
+<P>
+The <CODE>ActionResponse</CODE> interface represents the portlet
+ response to an action request.
+ It extends the <CODE>PortletResponse</CODE> interface to provide specific
+ action response functionality to portlets.<br>
+ The portlet container creates an <CODE>ActionResponse</CODE> object and
+ passes it as argument to the portlet's <CODE>processAction</CODE> method.
+<P>
+<DL>
+<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/ActionRequest.html"><CODE>ActionRequest</CODE></A>,
+<A HREF="../../javax/portlet/PortletResponse.html"><CODE>PortletResponse</CODE></A></DL>
+<HR>
+
+<P>
+<!-- ======== INNER CLASS SUMMARY ======== -->
+
+
+<!-- =========== FIELD SUMMARY =========== -->
+
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=2><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/ActionResponse.html#sendRedirect(java.lang.String)">sendRedirect</A></B>(java.lang.String location)</CODE>
+
+<BR>
+ Instructs the portlet container to send a redirect response
+ to the client using the specified redirect location URL.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/ActionResponse.html#setPortletMode(javax.portlet.PortletMode)">setPortletMode</A></B>(<A HREF="../../javax/portlet/PortletMode.html">PortletMode</A> portletMode)</CODE>
+
+<BR>
+ Sets the portlet mode of a portlet to the given portlet mode.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/ActionResponse.html#setRenderParameter(java.lang.String, java.lang.String)">setRenderParameter</A></B>(java.lang.String key,
+ java.lang.String value)</CODE>
+
+<BR>
+ Sets a String parameter for the render request.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/ActionResponse.html#setRenderParameter(java.lang.String, java.lang.String[])">setRenderParameter</A></B>(java.lang.String key,
+ java.lang.String[] values)</CODE>
+
+<BR>
+ Sets a String array parameter for the render request.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/ActionResponse.html#setRenderParameters(java.util.Map)">setRenderParameters</A></B>(java.util.Map parameters)</CODE>
+
+<BR>
+ Sets a parameter map for the render request.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/ActionResponse.html#setWindowState(javax.portlet.WindowState)">setWindowState</A></B>(<A HREF="../../javax/portlet/WindowState.html">WindowState</A> windowState)</CODE>
+
+<BR>
+ Sets the window state of a portlet to the given window state.</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_javax.portlet.PortletResponse"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TD><B>Methods inherited from interface javax.portlet.<A HREF="../../javax/portlet/PortletResponse.html">PortletResponse</A></B></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A HREF="../../javax/portlet/PortletResponse.html#addProperty(java.lang.String, java.lang.String)">addProperty</A>, <A HREF="../../javax/portlet/PortletResponse.html#encodeURL(java.lang.String)">encodeURL</A>, <A HREF="../../javax/portlet/PortletResponse.html#setProperty(java.lang.String, java.lang.String)">setProperty</A></CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=1><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TD>
+</TR>
+</TABLE>
+
+<A NAME="setWindowState(javax.portlet.WindowState)"><!-- --></A><H3>
+setWindowState</H3>
+<PRE>
+public void <B>setWindowState</B>(<A HREF="../../javax/portlet/WindowState.html">WindowState</A> windowState)
+ throws <A HREF="../../javax/portlet/WindowStateException.html">WindowStateException</A></PRE>
+<DL>
+<DD>Sets the window state of a portlet to the given window state.
+ <p>
+ Possible values are the standard window states and any custom
+ window states supported by the portal and the portlet.
+ Standard window states are:
+ <ul>
+ <li>MINIMIZED
+ <li>NORMAL
+ <li>MAXIMIZED
+ </ul><DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>windowState</CODE> - the new portlet window state<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/portlet/WindowStateException.html">WindowStateException</A></CODE> - if the portlet cannot switch to the specified window state.
+ To avoid this exception the portlet can check the allowed
+ window states with <code>Request.isWindowStateAllowed()</code>.<DD><CODE>java.lang.IllegalStateException</CODE> - if the method is invoked after <code>sendRedirect</code> has been called.<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/WindowState.html"><CODE>WindowState</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setPortletMode(javax.portlet.PortletMode)"><!-- --></A><H3>
+setPortletMode</H3>
+<PRE>
+public void <B>setPortletMode</B>(<A HREF="../../javax/portlet/PortletMode.html">PortletMode</A> portletMode)
+ throws <A HREF="../../javax/portlet/PortletModeException.html">PortletModeException</A></PRE>
+<DL>
+<DD>Sets the portlet mode of a portlet to the given portlet mode.
+ <p>
+ Possible values are the standard portlet modes and any custom
+ portlet modes supported by the portal and the portlet. Portlets
+ must declare in the deployment descriptor the portlet modes they
+ support for each markup type.
+ Standard portlet modes are:
+ <ul>
+ <li>EDIT
+ <li>HELP
+ <li>VIEW
+ </ul>
+ <p>
+ Note: The portlet may still be called in a different window
+ state in the next render call, depending on the portlet container / portal.<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>portletMode</CODE> - the new portlet mode<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/portlet/PortletModeException.html">PortletModeException</A></CODE> - if the portlet cannot switch to this portlet mode,
+ because the portlet or portal does not support it for this markup,
+ or the current user is not allowed to switch to this portlet mode.
+ To avoid this exception the portlet can check the allowed
+ portlet modes with <code>Request.isPortletModeAllowed()</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="sendRedirect(java.lang.String)"><!-- --></A><H3>
+sendRedirect</H3>
+<PRE>
+public void <B>sendRedirect</B>(java.lang.String location)
+ throws java.io.IOException</PRE>
+<DL>
+<DD>Instructs the portlet container to send a redirect response
+ to the client using the specified redirect location URL.
+ <p>
+ This method only accepts an absolute URL (e.g.
+ <code>http://my.co/myportal/mywebap/myfolder/myresource.gif</code>)
+ or a full path URI (e.g. <code>/myportal/mywebap/myfolder/myresource.gif</code>).
+ If required,
+ the portlet container may encode the given URL before the
+ redirection is issued to the client.
+ <p>
+ The sendRedirect method can not be invoked after any of the
+ following methods of the ActionResponse interface has been called:
+ <ul>
+ <li>setPortletMode
+ <li>setWindowState
+ <li>setRenderParameter
+ <li>setRenderParameters
+ </ul><DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>location</CODE> - the redirect location URL<DT><B>Throws:</B><DD><CODE>java.io.IOException</CODE> - if an input or output exception occurs.<DD><CODE>java.lang.IllegalArgumentException</CODE> - if a relative path URL is given<DD><CODE>java.lang.IllegalStateException</CODE> - if the method is invoked after any of above mentioned methods of
+ the ActionResponse interface has been called.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setRenderParameters(java.util.Map)"><!-- --></A><H3>
+setRenderParameters</H3>
+<PRE>
+public void <B>setRenderParameters</B>(java.util.Map 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.<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 key/values 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>
+public void <B>setRenderParameter</B>(java.lang.String key,
+ java.lang.String 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.<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 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="setRenderParameter(java.lang.String, java.lang.String[])"><!-- --></A><H3>
+setRenderParameter</H3>
+<PRE>
+public void <B>setRenderParameter</B>(java.lang.String key,
+ java.lang.String[] 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.<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>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+<!-- ========== START OF NAVBAR ========== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Portlet API (V1.0) </EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/ActionRequest.html"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/PortalContext.html"><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>
+ <A HREF="ActionResponse.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<!-- =========== END OF NAVBAR =========== -->
+
+<HR>
+<a href=license.txt >Copyright</a> © 2003 IBM Corporation and Sun Microsystems, Inc. All rights reserved
+</BODY>
+</HTML>
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/ActionResponse.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/ActionResponse.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/GenericPortlet.html
URL: http://svn.apache.org/viewvc/portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/GenericPortlet.html?rev=657263&view=auto
==============================================================================
--- portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/GenericPortlet.html (added)
+++ portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/GenericPortlet.html Fri May 16 17:57:32 2008
@@ -0,0 +1,692 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc on Mon Sep 08 18:33:40 CEST 2003 -->
+<TITLE>
+Portlet API (V1.0) : Class GenericPortlet
+</TITLE>
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
+</HEAD>
+<BODY BGCOLOR="white">
+
+<!-- ========== START OF NAVBAR ========== -->
+<A NAME="navbar_top"><!-- --></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Portlet API (V1.0) </EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ PREV CLASS
+ <A HREF="../../javax/portlet/PortletMode.html"><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>
+ <A HREF="GenericPortlet.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<!-- =========== END OF NAVBAR =========== -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+javax.portlet</FONT>
+<BR>
+Class GenericPortlet</H2>
+<PRE>
+java.lang.Object
+ |
+ +--<B>javax.portlet.GenericPortlet</B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../javax/portlet/Portlet.html">Portlet</A>, <A HREF="../../javax/portlet/PortletConfig.html">PortletConfig</A></DD>
+</DL>
+<HR>
+<DL>
+<DT>public abstract class <B>GenericPortlet</B><DT>extends java.lang.Object<DT>implements <A HREF="../../javax/portlet/Portlet.html">Portlet</A>, <A HREF="../../javax/portlet/PortletConfig.html">PortletConfig</A></DL>
+
+<P>
+The <CODE>GenericPortlet</CODE> class provides a default implementation
+ for the <CODE>Portlet</CODE> interface.
+ <p>
+ It provides an abstract class to be subclassed to create portlets. A
+ subclass of <CODE>GenericPortlet</CODE> should override at least
+ one method, usually one of the following:
+ <ul>
+ <li>processAction, to handle action requests</li>
+ <li>doView, to handle render requests when in VIEW mode</li>
+ <li>doEdit, to handle render requests when in EDIT mode</li>
+ <li>doHelp, to handle render request when in HELP mode</li>
+ <li>init and destroy, to manage resources that are held for the life of
+ the servlet</li>
+ </ul>
+ <p>
+ Normally there is no need to override the render or the doDispatch
+ methods. Render handles render requests setting the title of the
+ portlet in the response and invoking doDispatch. doDispatch dispatches
+ the request to one of the doView, doEdit or doHelp method depending on
+ the portlet mode indicated in the request.
+ <p>
+ Portlets typically run on multithreaded servers, so please note that a
+ portlet must handle concurrent requests and be careful to synchronize
+ access to shared resources. Shared resources include in-memory data
+ such as instance or class variables and external objects such as
+ files, database connections, and network connections.
+<P>
+<HR>
+
+<P>
+<!-- ======== INNER CLASS SUMMARY ======== -->
+
+
+<!-- =========== FIELD SUMMARY =========== -->
+
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=2><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#GenericPortlet()">GenericPortlet</A></B>()</CODE>
+
+<BR>
+ Does nothing.</TD>
+</TR>
+</TABLE>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=2><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#destroy()">destroy</A></B>()</CODE>
+
+<BR>
+ Called by the portlet container to indicate to a portlet that the portlet
+ is being taken out of service.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#doDispatch(javax.portlet.RenderRequest, javax.portlet.RenderResponse)">doDispatch</A></B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A> request,
+ <A HREF="../../javax/portlet/RenderResponse.html">RenderResponse</A> response)</CODE>
+
+<BR>
+ The default implementation of this method routes the render request
+ to a set of helper methods depending on the current portlet mode the
+ portlet is currently in.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#doEdit(javax.portlet.RenderRequest, javax.portlet.RenderResponse)">doEdit</A></B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A> request,
+ <A HREF="../../javax/portlet/RenderResponse.html">RenderResponse</A> response)</CODE>
+
+<BR>
+ Helper method to serve up the <code>edit</code> mode.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#doHelp(javax.portlet.RenderRequest, javax.portlet.RenderResponse)">doHelp</A></B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A> request,
+ <A HREF="../../javax/portlet/RenderResponse.html">RenderResponse</A> response)</CODE>
+
+<BR>
+ Helper method to serve up the <code>help</code> mode.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#doView(javax.portlet.RenderRequest, javax.portlet.RenderResponse)">doView</A></B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A> request,
+ <A HREF="../../javax/portlet/RenderResponse.html">RenderResponse</A> response)</CODE>
+
+<BR>
+ Helper method to serve up the mandatory <code>view</code> mode.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#getInitParameter(java.lang.String)">getInitParameter</A></B>(java.lang.String name)</CODE>
+
+<BR>
+ Returns a String containing the value of the named initialization parameter,
+ or null if the parameter does not exist.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Enumeration</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#getInitParameterNames()">getInitParameterNames</A></B>()</CODE>
+
+<BR>
+ Returns the names of the portlet initialization parameters as an
+ Enumeration of String objects, or an empty Enumeration if the
+ portlet has no initialization parameters.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../javax/portlet/PortletConfig.html">PortletConfig</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#getPortletConfig()">getPortletConfig</A></B>()</CODE>
+
+<BR>
+ Returns the PortletConfig object of this portlet.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../javax/portlet/PortletContext.html">PortletContext</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#getPortletContext()">getPortletContext</A></B>()</CODE>
+
+<BR>
+ Returns the <code>PortletContext</code> of the portlet application
+ the portlet is in.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#getPortletName()">getPortletName</A></B>()</CODE>
+
+<BR>
+ Returns the name of this portlet.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.ResourceBundle</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#getResourceBundle(java.util.Locale)">getResourceBundle</A></B>(java.util.Locale locale)</CODE>
+
+<BR>
+ Gets the resource bundle for the given locale based on the
+ resource bundle defined in the deployment descriptor
+ with <code>resource-bundle</code> tag or the inlined resources
+ defined in the deployment descriptor.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#getTitle(javax.portlet.RenderRequest)">getTitle</A></B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A> request)</CODE>
+
+<BR>
+ Used by the render method to get the title.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#init()">init</A></B>()</CODE>
+
+<BR>
+ A convenience method which can be overridden so that there's no need
+ to call <code>super.init(config)</code>.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#init(javax.portlet.PortletConfig)">init</A></B>(<A HREF="../../javax/portlet/PortletConfig.html">PortletConfig</A> config)</CODE>
+
+<BR>
+ Called by the portlet container to indicate to a portlet that the
+ portlet is being placed into service.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)">processAction</A></B>(<A HREF="../../javax/portlet/ActionRequest.html">ActionRequest</A> request,
+ <A HREF="../../javax/portlet/ActionResponse.html">ActionResponse</A> response)</CODE>
+
+<BR>
+ Called by the portlet container to allow the portlet to process
+ an action request.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)">render</A></B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A> request,
+ <A HREF="../../javax/portlet/RenderResponse.html">RenderResponse</A> response)</CODE>
+
+<BR>
+ The default implementation of this method sets the title
+ using the <code>getTitle</code> method and invokes the
+ <code>doDispatch</code> method.</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TD><B>Methods inherited from class java.lang.Object</B></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=1><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TD>
+</TR>
+</TABLE>
+
+<A NAME="GenericPortlet()"><!-- --></A><H3>
+GenericPortlet</H3>
+<PRE>
+public <B>GenericPortlet</B>()</PRE>
+<DL>
+<DD>Does nothing.</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=1><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TD>
+</TR>
+</TABLE>
+
+<A NAME="init(javax.portlet.PortletConfig)"><!-- --></A><H3>
+init</H3>
+<PRE>
+public void <B>init</B>(<A HREF="../../javax/portlet/PortletConfig.html">PortletConfig</A> config)
+ throws <A HREF="../../javax/portlet/PortletException.html">PortletException</A></PRE>
+<DL>
+<DD>Called by the portlet container to indicate to a portlet that the
+ portlet is being placed into service.
+ <p>
+ The default implementation just stores the <code>PortletConfig</code>
+ object.
+ <p>The portlet container calls the <code>init</code>
+ method exactly once after instantiating the portlet.
+ The <code>init</code> method must complete successfully
+ before the portlet can receive any requests.
+
+ <p>The portlet container cannot place the portlet into service
+ if the <code>init</code> method does one of the following:
+ <ol>
+ <li>it throws a <code>PortletException</code>
+ <li>it does not return within a time period defined by the Web server
+ </ol><DD><DL>
+<DT><B>Specified by: </B><DD><CODE><A HREF="../../javax/portlet/Portlet.html#init(javax.portlet.PortletConfig)">init</A></CODE> in interface <CODE><A HREF="../../javax/portlet/Portlet.html">Portlet</A></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>config</CODE> - a <code>PortletConfig</code> object
+ containing the portlet
+ configuration and initialization parameters<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/portlet/PortletException.html">PortletException</A></CODE> - if an exception has occurred that
+ interferes with the portlet normal
+ operation.<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html">UnavailableException</A></CODE> - if the portlet cannot perform the initialization at this time.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="init()"><!-- --></A><H3>
+init</H3>
+<PRE>
+public void <B>init</B>()
+ throws <A HREF="../../javax/portlet/PortletException.html">PortletException</A></PRE>
+<DL>
+<DD>A convenience method which can be overridden so that there's no need
+ to call <code>super.init(config)</code>.
+
+ <p>Instead of overriding <A HREF="../../javax/portlet/GenericPortlet.html#init(javax.portlet.PortletConfig)"><CODE>init(PortletConfig)</CODE></A>, simply override
+ this method and it will be called by
+ <code>GenericPortlet.init(PortletConfig config)</code>.
+ The <code>PortletConfig</code> object can still be retrieved via <A HREF="../../javax/portlet/GenericPortlet.html#getPortletConfig()"><CODE>getPortletConfig()</CODE></A>.<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/portlet/PortletException.html">PortletException</A></CODE> - if an exception has occurred that
+ interferes with the portlet normal
+ operation.<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html">UnavailableException</A></CODE> - if the portlet is unavailable to perform init</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)"><!-- --></A><H3>
+processAction</H3>
+<PRE>
+public void <B>processAction</B>(<A HREF="../../javax/portlet/ActionRequest.html">ActionRequest</A> request,
+ <A HREF="../../javax/portlet/ActionResponse.html">ActionResponse</A> response)
+ throws <A HREF="../../javax/portlet/PortletException.html">PortletException</A>,
+ java.io.IOException</PRE>
+<DL>
+<DD>Called by the portlet container to allow the portlet to process
+ an action request. This method is called if the client request was
+ originated by a URL created (by the portlet) with the
+ <code>RenderResponse.createActionURL()</code> method.
+ <p>
+ The default implementation throws an exception.<DD><DL>
+<DT><B>Specified by: </B><DD><CODE><A HREF="../../javax/portlet/Portlet.html#processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)">processAction</A></CODE> in interface <CODE><A HREF="../../javax/portlet/Portlet.html">Portlet</A></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>request</CODE> - the action request<DD><CODE>response</CODE> - the action response<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/portlet/PortletException.html">PortletException</A></CODE> - if the portlet cannot fulfilling the request<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html">UnavailableException</A></CODE> - if the portlet is unavailable to process the action at this time<DD><CODE><A HREF="../../javax/portlet/PortletSecurityException.html">PortletSecurityException</A></CODE> - if the portlet cannot fullfill this request because of security reasons<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
+render</H3>
+<PRE>
+public void <B>render</B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A> request,
+ <A HREF="../../javax/portlet/RenderResponse.html">RenderResponse</A> response)
+ throws <A HREF="../../javax/portlet/PortletException.html">PortletException</A>,
+ java.io.IOException</PRE>
+<DL>
+<DD>The default implementation of this method sets the title
+ using the <code>getTitle</code> method and invokes the
+ <code>doDispatch</code> method.<DD><DL>
+<DT><B>Specified by: </B><DD><CODE><A HREF="../../javax/portlet/Portlet.html#render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)">render</A></CODE> in interface <CODE><A HREF="../../javax/portlet/Portlet.html">Portlet</A></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>request</CODE> - the render request<DD><CODE>response</CODE> - the render response<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/portlet/PortletException.html">PortletException</A></CODE> - if the portlet cannot fulfilling the request<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html">UnavailableException</A></CODE> - if the portlet is unavailable to perform render at this time<DD><CODE><A HREF="../../javax/portlet/PortletSecurityException.html">PortletSecurityException</A></CODE> - if the portlet cannot fullfill this request because of security reasons<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getTitle(javax.portlet.RenderRequest)"><!-- --></A><H3>
+getTitle</H3>
+<PRE>
+protected java.lang.String <B>getTitle</B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A> request)</PRE>
+<DL>
+<DD>Used by the render method to get the title.
+ <p>
+ The default implementation gets the title from the ResourceBundle
+ of the PortletConfig of the portlet. The title is retrieved
+ using the 'javax.portlet.title' resource name.
+ <p>
+ Portlets can overwrite this method to provide dynamic
+ titles (e.g. based on locale, client, and session information).
+ Examples are:
+ <UL>
+ <LI>language-dependant titles for multi-lingual portals
+ <LI>shorter titles for WAP phones
+ <LI>the number of messages in a mailbox portlet
+ </UL><DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Returns:</B><DD>the portlet title for this window</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="doDispatch(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
+doDispatch</H3>
+<PRE>
+protected void <B>doDispatch</B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A> request,
+ <A HREF="../../javax/portlet/RenderResponse.html">RenderResponse</A> response)
+ throws <A HREF="../../javax/portlet/PortletException.html">PortletException</A>,
+ java.io.IOException</PRE>
+<DL>
+<DD>The default implementation of this method routes the render request
+ to a set of helper methods depending on the current portlet mode the
+ portlet is currently in.
+ These methods are:
+ <ul>
+ <li><code>doView</code> for handling <code>view</code> requests
+ <li><code>doEdit</code> for handling <code>edit</code> requests
+ <li><code>doHelp</code> for handling <code>help</code> requests
+ </ul>
+ <P>
+ If the window state of this portlet is <code>minimized</code>, this
+ method does not invoke any of the portlet mode rendering methods.
+ <p>
+ For handling custom portlet modes the portlet should override this
+ method.<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>request</CODE> - the render request<DD><CODE>response</CODE> - the render response<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/portlet/PortletException.html">PortletException</A></CODE> - if the portlet cannot fulfilling the request<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html">UnavailableException</A></CODE> - if the portlet is unavailable to perform render at this time<DD><CODE><A HREF="../../javax/portlet/PortletSecurityException.html">PortletSecurityException</A></CODE> - if the portlet cannot fullfill this request because of security reasons<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/GenericPortlet.html#doView(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><CODE>doView(RenderRequest, RenderResponse)</CODE></A>,
+<A HREF="../../javax/portlet/GenericPortlet.html#doEdit(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><CODE>doEdit(RenderRequest, RenderResponse)</CODE></A>,
+<A HREF="../../javax/portlet/GenericPortlet.html#doHelp(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><CODE>doHelp(RenderRequest, RenderResponse)</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="doView(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
+doView</H3>
+<PRE>
+protected void <B>doView</B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A> request,
+ <A HREF="../../javax/portlet/RenderResponse.html">RenderResponse</A> response)
+ throws <A HREF="../../javax/portlet/PortletException.html">PortletException</A>,
+ java.io.IOException</PRE>
+<DL>
+<DD>Helper method to serve up the mandatory <code>view</code> mode.
+ <p>
+ The default implementation throws an exception.<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>request</CODE> - the portlet request<DD><CODE>response</CODE> - the render response<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/portlet/PortletException.html">PortletException</A></CODE> - if the portlet cannot fulfilling the request<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html">UnavailableException</A></CODE> - if the portlet is unavailable to perform render at this time<DD><CODE><A HREF="../../javax/portlet/PortletSecurityException.html">PortletSecurityException</A></CODE> - if the portlet cannot fullfill this request because of security reasons<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="doEdit(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
+doEdit</H3>
+<PRE>
+protected void <B>doEdit</B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A> request,
+ <A HREF="../../javax/portlet/RenderResponse.html">RenderResponse</A> response)
+ throws <A HREF="../../javax/portlet/PortletException.html">PortletException</A>,
+ java.io.IOException</PRE>
+<DL>
+<DD>Helper method to serve up the <code>edit</code> mode.
+ <p>
+ The default implementation throws an exception.<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>request</CODE> - the portlet request<DD><CODE>response</CODE> - the render response<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/portlet/PortletException.html">PortletException</A></CODE> - if the portlet cannot fulfilling the request<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html">UnavailableException</A></CODE> - if the portlet is unavailable to perform render at this time<DD><CODE><A HREF="../../javax/portlet/PortletSecurityException.html">PortletSecurityException</A></CODE> - if the portlet cannot fullfill this request because of security reasons<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="doHelp(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
+doHelp</H3>
+<PRE>
+protected void <B>doHelp</B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A> request,
+ <A HREF="../../javax/portlet/RenderResponse.html">RenderResponse</A> response)
+ throws <A HREF="../../javax/portlet/PortletException.html">PortletException</A>,
+ java.io.IOException</PRE>
+<DL>
+<DD>Helper method to serve up the <code>help</code> mode.
+ <p>
+ The default implementation throws an exception.<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>request</CODE> - the portlet request<DD><CODE>response</CODE> - the render response<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/portlet/PortletException.html">PortletException</A></CODE> - if the portlet cannot fulfilling the request<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html">UnavailableException</A></CODE> - if the portlet is unavailable to perform render at this time<DD><CODE><A HREF="../../javax/portlet/PortletSecurityException.html">PortletSecurityException</A></CODE> - if the portlet cannot fullfill this request because of security reasons<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getPortletConfig()"><!-- --></A><H3>
+getPortletConfig</H3>
+<PRE>
+public <A HREF="../../javax/portlet/PortletConfig.html">PortletConfig</A> <B>getPortletConfig</B>()</PRE>
+<DL>
+<DD>Returns the PortletConfig object of this portlet.<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Returns:</B><DD>the PortletConfig object of this portlet</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="destroy()"><!-- --></A><H3>
+destroy</H3>
+<PRE>
+public void <B>destroy</B>()</PRE>
+<DL>
+<DD>Called by the portlet container to indicate to a portlet that the portlet
+ is being taken out of service.
+ <p>
+ The default implementation does nothing.<DD><DL>
+<DT><B>Specified by: </B><DD><CODE><A HREF="../../javax/portlet/Portlet.html#destroy()">destroy</A></CODE> in interface <CODE><A HREF="../../javax/portlet/Portlet.html">Portlet</A></CODE></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getPortletName()"><!-- --></A><H3>
+getPortletName</H3>
+<PRE>
+public java.lang.String <B>getPortletName</B>()</PRE>
+<DL>
+<DD>Returns the name of this portlet.<DD><DL>
+<DT><B>Specified by: </B><DD><CODE><A HREF="../../javax/portlet/PortletConfig.html#getPortletName()">getPortletName</A></CODE> in interface <CODE><A HREF="../../javax/portlet/PortletConfig.html">PortletConfig</A></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Returns:</B><DD>the portlet name<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/PortletConfig.html#getPortletName()"><CODE>PortletConfig.getPortletName()</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getPortletContext()"><!-- --></A><H3>
+getPortletContext</H3>
+<PRE>
+public <A HREF="../../javax/portlet/PortletContext.html">PortletContext</A> <B>getPortletContext</B>()</PRE>
+<DL>
+<DD>Returns the <code>PortletContext</code> of the portlet application
+ the portlet is in.<DD><DL>
+<DT><B>Specified by: </B><DD><CODE><A HREF="../../javax/portlet/PortletConfig.html#getPortletContext()">getPortletContext</A></CODE> in interface <CODE><A HREF="../../javax/portlet/PortletConfig.html">PortletConfig</A></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Returns:</B><DD>the portlet application context</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getResourceBundle(java.util.Locale)"><!-- --></A><H3>
+getResourceBundle</H3>
+<PRE>
+public java.util.ResourceBundle <B>getResourceBundle</B>(java.util.Locale locale)</PRE>
+<DL>
+<DD>Gets the resource bundle for the given locale based on the
+ resource bundle defined in the deployment descriptor
+ with <code>resource-bundle</code> tag or the inlined resources
+ defined in the deployment descriptor.<DD><DL>
+<DT><B>Specified by: </B><DD><CODE><A HREF="../../javax/portlet/PortletConfig.html#getResourceBundle(java.util.Locale)">getResourceBundle</A></CODE> in interface <CODE><A HREF="../../javax/portlet/PortletConfig.html">PortletConfig</A></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Returns:</B><DD>the resource bundle for the given locale</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getInitParameter(java.lang.String)"><!-- --></A><H3>
+getInitParameter</H3>
+<PRE>
+public java.lang.String <B>getInitParameter</B>(java.lang.String name)</PRE>
+<DL>
+<DD>Returns a String containing the value of the named initialization parameter,
+ or null if the parameter does not exist.<DD><DL>
+<DT><B>Specified by: </B><DD><CODE><A HREF="../../javax/portlet/PortletConfig.html#getInitParameter(java.lang.String)">getInitParameter</A></CODE> in interface <CODE><A HREF="../../javax/portlet/PortletConfig.html">PortletConfig</A></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - a <code>String</code> specifying the name
+ of the initialization parameter<DT><B>Returns:</B><DD>a <code>String</code> containing the value
+ of the initialization parameter<DT><B>Throws:</B><DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getInitParameterNames()"><!-- --></A><H3>
+getInitParameterNames</H3>
+<PRE>
+public java.util.Enumeration <B>getInitParameterNames</B>()</PRE>
+<DL>
+<DD>Returns the names of the portlet initialization parameters as an
+ Enumeration of String objects, or an empty Enumeration if the
+ portlet has no initialization parameters.<DD><DL>
+<DT><B>Specified by: </B><DD><CODE><A HREF="../../javax/portlet/PortletConfig.html#getInitParameterNames()">getInitParameterNames</A></CODE> in interface <CODE><A HREF="../../javax/portlet/PortletConfig.html">PortletConfig</A></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Returns:</B><DD>an <code>Enumeration</code> of <code>String</code>
+ objects containing the names of the portlet
+ initialization parameters, or an empty Enumeration if the
+ portlet has no initialization parameters.</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+<!-- ========== START OF NAVBAR ========== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Portlet API (V1.0) </EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ PREV CLASS
+ <A HREF="../../javax/portlet/PortletMode.html"><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>
+ <A HREF="GenericPortlet.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<!-- =========== END OF NAVBAR =========== -->
+
+<HR>
+<a href=license.txt >Copyright</a> © 2003 IBM Corporation and Sun Microsystems, Inc. All rights reserved
+</BODY>
+</HTML>
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/GenericPortlet.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/GenericPortlet.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortalContext.html
URL: http://svn.apache.org/viewvc/portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortalContext.html?rev=657263&view=auto
==============================================================================
--- portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortalContext.html (added)
+++ portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortalContext.html Fri May 16 17:57:32 2008
@@ -0,0 +1,274 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc on Mon Sep 08 18:33:40 CEST 2003 -->
+<TITLE>
+Portlet API (V1.0) : Interface PortalContext
+</TITLE>
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
+</HEAD>
+<BODY BGCOLOR="white">
+
+<!-- ========== START OF NAVBAR ========== -->
+<A NAME="navbar_top"><!-- --></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Portlet API (V1.0) </EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/ActionResponse.html"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/Portlet.html"><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>
+ <A HREF="PortalContext.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<!-- =========== END OF NAVBAR =========== -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+javax.portlet</FONT>
+<BR>
+Interface PortalContext</H2>
+<HR>
+<DL>
+<DT>public interface <B>PortalContext</B></DL>
+
+<P>
+The <CODE>PortalContext</CODE> interface gives the portlet
+ the ability to retrieve information about the portal calling this portlet.
+ <p>
+ The portlet can only read the <CODE>PortalContext</CODE> data.
+<P>
+<HR>
+
+<P>
+<!-- ======== INNER CLASS SUMMARY ======== -->
+
+
+<!-- =========== FIELD SUMMARY =========== -->
+
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=2><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortalContext.html#getPortalInfo()">getPortalInfo</A></B>()</CODE>
+
+<BR>
+ Returns information about the portal like vendor, version, etc.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortalContext.html#getProperty(java.lang.String)">getProperty</A></B>(java.lang.String name)</CODE>
+
+<BR>
+ Returns the portal property with the given name,
+ or a <code>null</code> if there is
+ no property by that name.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Enumeration</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortalContext.html#getPropertyNames()">getPropertyNames</A></B>()</CODE>
+
+<BR>
+ Returns all portal property names, or an empty
+ <code>Enumeration</code> if there are no property names.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Enumeration</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortalContext.html#getSupportedPortletModes()">getSupportedPortletModes</A></B>()</CODE>
+
+<BR>
+ Returns all supported portlet modes by the portal
+ as an enumertation of <code>PorltetMode</code> objects.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Enumeration</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortalContext.html#getSupportedWindowStates()">getSupportedWindowStates</A></B>()</CODE>
+
+<BR>
+ Returns all supported window states by the portal
+ as an enumertation of <code>WindowState</code> objects.</TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=1><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TD>
+</TR>
+</TABLE>
+
+<A NAME="getProperty(java.lang.String)"><!-- --></A><H3>
+getProperty</H3>
+<PRE>
+public java.lang.String <B>getProperty</B>(java.lang.String name)</PRE>
+<DL>
+<DD>Returns the portal property with the given name,
+ or a <code>null</code> if there is
+ no property by that name.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - property name<DT><B>Returns:</B><DD>portal property with key <code>name</code><DT><B>Throws:</B><DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getPropertyNames()"><!-- --></A><H3>
+getPropertyNames</H3>
+<PRE>
+public java.util.Enumeration <B>getPropertyNames</B>()</PRE>
+<DL>
+<DD>Returns all portal property names, or an empty
+ <code>Enumeration</code> if there are no property names.<DD><DL>
+<DT><B>Returns:</B><DD>All portal property names as an
+ <code>Enumeration</code> of <code>String</code> objects</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getSupportedPortletModes()"><!-- --></A><H3>
+getSupportedPortletModes</H3>
+<PRE>
+public java.util.Enumeration <B>getSupportedPortletModes</B>()</PRE>
+<DL>
+<DD>Returns all supported portlet modes by the portal
+ as an enumertation of <code>PorltetMode</code> objects.
+ <p>
+ The portlet modes must at least include the
+ standard portlet modes <code>EDIT, HELP, VIEW</code>.<DD><DL>
+<DT><B>Returns:</B><DD>All supported portal modes by the portal
+ as an enumertation of <code>PorltetMode</code> objects.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getSupportedWindowStates()"><!-- --></A><H3>
+getSupportedWindowStates</H3>
+<PRE>
+public java.util.Enumeration <B>getSupportedWindowStates</B>()</PRE>
+<DL>
+<DD>Returns all supported window states by the portal
+ as an enumertation of <code>WindowState</code> objects.
+ <p>
+ The window states must at least include the
+ standard window states <code> MINIMIZED, NORMAL, MAXIMIZED</code>.<DD><DL>
+<DT><B>Returns:</B><DD>All supported window states by the portal
+ as an enumertation of <code>WindowState</code> objects.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getPortalInfo()"><!-- --></A><H3>
+getPortalInfo</H3>
+<PRE>
+public java.lang.String <B>getPortalInfo</B>()</PRE>
+<DL>
+<DD>Returns information about the portal like vendor, version, etc.
+ <p>
+ The form of the returned string is <I>servername/versionnumber</I>. For
+ example, the reference implementation Pluto may return the string
+ <CODE>Pluto/1.0</CODE>.
+ <p>
+ The portlet container may return other optional information after the
+ primary string in parentheses, for example, <CODE>Pluto/1.0
+ (JDK 1.3.1; Windows NT 4.0 x86)</CODE>.<DD><DL>
+<DT><B>Returns:</B><DD>a <CODE>String</CODE> containing at least the portal name and version number</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+<!-- ========== START OF NAVBAR ========== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+Portlet API (V1.0) </EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/ActionResponse.html"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/Portlet.html"><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>
+ <A HREF="PortalContext.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<!-- =========== END OF NAVBAR =========== -->
+
+<HR>
+<a href=license.txt >Copyright</a> © 2003 IBM Corporation and Sun Microsystems, Inc. All rights reserved
+</BODY>
+</HTML>
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortalContext.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortalContext.html
------------------------------------------------------------------------------
svn:mime-type = text/html