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 at...@apache.org on 2008/11/02 23:19:09 UTC
svn commit: r709960 [21/23] - in
/portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs:
./ index-files/ javax/portlet/ javax/portlet/class-use/
javax/portlet/filter/ javax/portlet/listener/
Added: portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/StateAwareResponse.html
URL: http://svn.apache.org/viewvc/portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/StateAwareResponse.html?rev=709960&view=auto
==============================================================================
--- portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/StateAwareResponse.html (added)
+++ portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/StateAwareResponse.html Sun Nov 2 14:19:07 2008
@@ -0,0 +1,630 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0) on Wed Feb 06 17:53:07 CET 2008 -->
+<TITLE>
+StateAwareResponse
+</TITLE>
+
+<META NAME="keywords" CONTENT="javax.portlet.StateAwareResponse interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="StateAwareResponse";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_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> </TD>
+ <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="class-use/StateAwareResponse.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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-files/index-1.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>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/ResourceURL.html" title="interface in javax.portlet"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/UnavailableException.html" title="class in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../index.html?javax/portlet/StateAwareResponse.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="StateAwareResponse.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | 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>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+javax.portlet</FONT>
+<BR>
+Interface StateAwareResponse</H2>
+<DL>
+<DT><B>All Superinterfaces:</B> <DD><A HREF="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</A></DD>
+</DL>
+<DL>
+<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../javax/portlet/ActionResponse.html" title="interface in javax.portlet">ActionResponse</A>, <A HREF="../../javax/portlet/EventResponse.html" title="interface in javax.portlet">EventResponse</A></DD>
+</DL>
+<DL>
+<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../javax/portlet/filter/ActionResponseWrapper.html" title="class in javax.portlet.filter">ActionResponseWrapper</A>, <A HREF="../../javax/portlet/filter/EventResponseWrapper.html" title="class in javax.portlet.filter">EventResponseWrapper</A></DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public interface <B>StateAwareResponse</B><DT>extends <A HREF="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</A></DL>
+</PRE>
+
+<P>
+The <CODE>StateAwareResponse</CODE> represents a response that can modify
+ state information or send events.<BR>
+ It extends the PortletResponse interface.
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+ <DD>2.0</DD>
+<DT><B>See Also:</B><DD><A HREF="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet"><CODE>PortletResponse</CODE></A></DL>
+<HR>
+
+<P>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/StateAwareResponse.html#getPortletMode()">getPortletMode</A></B>()</CODE>
+
+<BR>
+ Returns the currently set portlet mode on this reponse.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Map<java.lang.String,java.lang.String[]></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/StateAwareResponse.html#getRenderParameterMap()">getRenderParameterMap</A></B>()</CODE>
+
+<BR>
+ Returns a <code>Map</code> of the render parameters currently set on
+ this response.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/StateAwareResponse.html#getWindowState()">getWindowState</A></B>()</CODE>
+
+<BR>
+ Returns the currently set window state on this response.</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/StateAwareResponse.html#removePublicRenderParameter(java.lang.String)">removePublicRenderParameter</A></B>(java.lang.String name)</CODE>
+
+<BR>
+ Removes the specified public render parameter.</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/StateAwareResponse.html#setEvent(javax.xml.namespace.QName, java.io.Serializable)">setEvent</A></B>(javax.xml.namespace.QName name,
+ java.io.Serializable value)</CODE>
+
+<BR>
+ Publishes an Event with the given payload.</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/StateAwareResponse.html#setEvent(java.lang.String, java.io.Serializable)">setEvent</A></B>(java.lang.String name,
+ java.io.Serializable value)</CODE>
+
+<BR>
+ Publishes an Event with the given payload in the default namespace.</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/StateAwareResponse.html#setPortletMode(javax.portlet.PortletMode)">setPortletMode</A></B>(<A HREF="../../javax/portlet/PortletMode.html" title="class in javax.portlet">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/StateAwareResponse.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/StateAwareResponse.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/StateAwareResponse.html#setRenderParameters(java.util.Map)">setRenderParameters</A></B>(java.util.Map<java.lang.String,java.lang.String[]> 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/StateAwareResponse.html#setWindowState(javax.portlet.WindowState)">setWindowState</A></B>(<A HREF="../../javax/portlet/WindowState.html" title="class in javax.portlet">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" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from interface javax.portlet.<A HREF="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</A></B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A HREF="../../javax/portlet/PortletResponse.html#addProperty(javax.servlet.http.Cookie)">addProperty</A>, <A HREF="../../javax/portlet/PortletResponse.html#addProperty(java.lang.String, org.w3c.dom.Element)">addProperty</A>, <A HREF="../../javax/portlet/PortletResponse.html#addProperty(java.lang.String, java.lang.String)">addProperty</A>, <A HREF="../../javax/portlet/PortletResponse.html#createElement(java.lang.String)">createElement</A>, <A HREF="../../javax/portlet/PortletResponse.html#encodeURL(java.lang.String)">encodeURL</A>, <A HREF="../../javax/portlet/PortletResponse.html#getNamespace()">getNamespace</A>, <A HREF="../../javax/portlet/PortletResponse.html#setProperty(java.lang.String, java.lang.String)">setProperty</A></CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="setWindowState(javax.portlet.WindowState)"><!-- --></A><H3>
+setWindowState</H3>
+<PRE>
+void <B>setWindowState</B>(<A HREF="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</A> windowState)
+ throws <A HREF="../../javax/portlet/WindowStateException.html" title="class in javax.portlet">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>
+<P>
+<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" title="class in javax.portlet">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" title="class in javax.portlet"><CODE>WindowState</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setPortletMode(javax.portlet.PortletMode)"><!-- --></A><H3>
+setPortletMode</H3>
+<PRE>
+void <B>setPortletMode</B>(<A HREF="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</A> portletMode)
+ throws <A HREF="../../javax/portlet/PortletModeException.html" title="class in javax.portlet">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.
+<P>
+<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" title="class in javax.portlet">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="setRenderParameters(java.util.Map)"><!-- --></A><H3>
+setRenderParameters</H3>
+<PRE>
+void <B>setRenderParameters</B>(java.util.Map<java.lang.String,java.lang.String[]> 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.
+ <p>
+ The portlet should not modify the map any further after calling
+ this method.
+<P>
+<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
+ keys 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>
+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.
+<P>
+<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 is <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>
+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.
+<P>
+<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>
+<HR>
+
+<A NAME="setEvent(javax.xml.namespace.QName, java.io.Serializable)"><!-- --></A><H3>
+setEvent</H3>
+<PRE>
+void <B>setEvent</B>(javax.xml.namespace.QName name,
+ java.io.Serializable value)</PRE>
+<DL>
+<DD>Publishes an Event with the given payload.
+ <p>
+ The object type of the value must be compliant with the specified event
+ type in the portlet deployment descriptor.
+ <p>
+ The value must have a valid JAXB binding and be serializable.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - the event name to publish, must not be <code>null</code><DD><CODE>value</CODE> - the value of this event, must have a valid JAXB binding and
+ be serializable, or <code>null</code>.
+<DT><B>Throws:</B>
+<DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>, the value is not
+ serializable, the value does not have a valid JAXB binding, the
+ object type of the value is not the same as specified in
+ the portlet deployment descriptor for this event name.<DT><B>Since:</B></DT>
+ <DD>2.0</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setEvent(java.lang.String, java.io.Serializable)"><!-- --></A><H3>
+setEvent</H3>
+<PRE>
+void <B>setEvent</B>(java.lang.String name,
+ java.io.Serializable value)</PRE>
+<DL>
+<DD>Publishes an Event with the given payload in the default namespace.
+ <p>
+ The name is treated as local part of the event QName and the namespace
+ is either taken from the <code>default-event-namespace</code> element
+ in the portlet deployment descriptor, or if this element is not provided
+ the XML default namespace XMLConstants.NULL_NS_URI is used.
+ <p>
+ The object type of the value must be compliant with the specified event
+ type in the portlet deployment descriptor.
+ <p>
+ The value must have a valid JAXB binding and be serializable.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - the local part of the event name to publish, must not be <code>null</code><DD><CODE>value</CODE> - the value of this event, must have a valid JAXB binding and
+ be serializable, or <code>null</code>.
+<DT><B>Throws:</B>
+<DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>, the value is not
+ serializable, the value does not have a valid JAXB binding, the
+ object type of the value is not the same as specified in
+ the portlet deployment descriptor for this event name.<DT><B>Since:</B></DT>
+ <DD>2.0</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getRenderParameterMap()"><!-- --></A><H3>
+getRenderParameterMap</H3>
+<PRE>
+java.util.Map<java.lang.String,java.lang.String[]> <B>getRenderParameterMap</B>()</PRE>
+<DL>
+<DD>Returns a <code>Map</code> of the render parameters currently set on
+ this response.
+ <p>
+ The values in the returned <code>Map</code> are from type String array (<code>String[]</code>).
+ <p>
+ If no parameters exist this method returns an empty <code>Map</code>.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD><code>Map</code> containing render parameter names as keys and
+ parameter values as map values, or an empty <code>Map</code> if
+ no parameters exist. The keys in the parameter map are of type
+ String. The values in the parameter map are of type String array (<code>String[]</code>).<DT><B>Since:</B></DT>
+ <DD>2.0</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getPortletMode()"><!-- --></A><H3>
+getPortletMode</H3>
+<PRE>
+<A HREF="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</A> <B>getPortletMode</B>()</PRE>
+<DL>
+<DD>Returns the currently set portlet mode on this reponse.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the portlet mode, or <code>null</code> if none is set<DT><B>Since:</B></DT>
+ <DD>2.0</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getWindowState()"><!-- --></A><H3>
+getWindowState</H3>
+<PRE>
+<A HREF="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</A> <B>getWindowState</B>()</PRE>
+<DL>
+<DD>Returns the currently set window state on this response.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the window state, or <code>null</code> if none is set<DT><B>Since:</B></DT>
+ <DD>2.0</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="removePublicRenderParameter(java.lang.String)"><!-- --></A><H3>
+removePublicRenderParameter</H3>
+<PRE>
+void <B>removePublicRenderParameter</B>(java.lang.String name)</PRE>
+<DL>
+<DD>Removes the specified public render parameter.
+ The name must reference a public render parameter defined
+ in the portlet deployment descriptor under the
+ <code>public-render-parameter</code> element with the
+ <code>identifier</code> mapping to the parameter name.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - a <code>String</code> specifying
+ the name of the public render parameter to be removed
+<DT><B>Throws:</B>
+<DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.<DT><B>Since:</B></DT>
+ <DD>2.0</DD>
+</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=2 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> </TD>
+ <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="class-use/StateAwareResponse.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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-files/index-1.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>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/ResourceURL.html" title="interface in javax.portlet"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/UnavailableException.html" title="class in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../index.html?javax/portlet/StateAwareResponse.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="StateAwareResponse.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | 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>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+
+</BODY>
+</HTML>
Propchange: portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/StateAwareResponse.html
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/UnavailableException.html
URL: http://svn.apache.org/viewvc/portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/UnavailableException.html?rev=709960&view=auto
==============================================================================
--- portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/UnavailableException.html (added)
+++ portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/UnavailableException.html Sun Nov 2 14:19:07 2008
@@ -0,0 +1,361 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0) on Wed Feb 06 17:53:07 CET 2008 -->
+<TITLE>
+UnavailableException
+</TITLE>
+
+<META NAME="keywords" CONTENT="javax.portlet.UnavailableException class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="UnavailableException";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_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> </TD>
+ <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="class-use/UnavailableException.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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-files/index-1.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>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/ValidatorException.html" title="class in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../index.html?javax/portlet/UnavailableException.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="UnavailableException.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | 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>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+javax.portlet</FONT>
+<BR>
+Class UnavailableException</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
+ <IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
+ <IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">javax.portlet.PortletException</A>
+ <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.portlet.UnavailableException</B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public class <B>UnavailableException</B><DT>extends <A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A></DL>
+</PRE>
+
+<P>
+The portlet should throw the <CODE>UnavailableException</CODE> when
+ the portlet is either temporarily or permanently unavailable to handle requests.
+<P>
+
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#javax.portlet.UnavailableException">Serialized Form</A></DL>
+<HR>
+
+<P>
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../javax/portlet/UnavailableException.html#UnavailableException(java.lang.String)">UnavailableException</A></B>(java.lang.String text)</CODE>
+
+<BR>
+ Constructs a new exception with a descriptive
+ message indicating that the portlet is permanently
+ unavailable.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../javax/portlet/UnavailableException.html#UnavailableException(java.lang.String, int)">UnavailableException</A></B>(java.lang.String text,
+ int seconds)</CODE>
+
+<BR>
+ Constructs a new exception with a descriptive message
+ indicating that the portlet is temporarily unavailable
+ and giving an estimate of how long it will be unavailable.</TD>
+</TR>
+</TABLE>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</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/UnavailableException.html#getUnavailableSeconds()">getUnavailableSeconds</A></B>()</CODE>
+
+<BR>
+ Returns the time in seconds for which the portlet can be expected to
+ be unavailable.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/UnavailableException.html#isPermanent()">isPermanent</A></B>()</CODE>
+
+<BR>
+ Returns a <code>boolean</code> indicating
+ whether the portlet is permanently unavailable.</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="UnavailableException(java.lang.String)"><!-- --></A><H3>
+UnavailableException</H3>
+<PRE>
+public <B>UnavailableException</B>(java.lang.String text)</PRE>
+<DL>
+<DD>Constructs a new exception with a descriptive
+ message indicating that the portlet is permanently
+ unavailable.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>text</CODE> - a <code>String</code> specifying the
+ descriptive message</DL>
+</DL>
+<HR>
+
+<A NAME="UnavailableException(java.lang.String, int)"><!-- --></A><H3>
+UnavailableException</H3>
+<PRE>
+public <B>UnavailableException</B>(java.lang.String text,
+ int seconds)</PRE>
+<DL>
+<DD>Constructs a new exception with a descriptive message
+ indicating that the portlet is temporarily unavailable
+ and giving an estimate of how long it will be unavailable.
+
+ <p>In some cases, the portlet cannot make an estimate. For
+ example, the portlet might know that a server it needs is
+ not running, but it might not be able to report how long it will take
+ to be restored to functionality. This can be indicated with
+ a negative or zero value for the <code>seconds</code> argument.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>text</CODE> - a <code>String</code> specifying the
+ descriptive message. This message can be written
+ to a log file or displayed for the user.<DD><CODE>seconds</CODE> - an integer specifying the number of seconds
+ for which the portlet expects to be unavailable; if
+ this is zero or negative, it indicates that the portlet
+ cannot make an estimate.</DL>
+</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="isPermanent()"><!-- --></A><H3>
+isPermanent</H3>
+<PRE>
+public boolean <B>isPermanent</B>()</PRE>
+<DL>
+<DD>Returns a <code>boolean</code> indicating
+ whether the portlet is permanently unavailable.
+ If so, something is wrong with the portlet, and the
+ system administrator must take some corrective action.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD><code>true</code> if the portlet is
+ permanently unavailable; <code>false</code>
+ if the portlet is temporarily
+ unavailable.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getUnavailableSeconds()"><!-- --></A><H3>
+getUnavailableSeconds</H3>
+<PRE>
+public int <B>getUnavailableSeconds</B>()</PRE>
+<DL>
+<DD>Returns the time in seconds for which the portlet can be expected to
+ be unavailable.
+ <p>
+ If the portlet is called again while it is still unavailable, it
+ indicates the same time estimate. No effort is
+ made to correct for the time elapsed since the exception was
+ first reported.
+ <p>
+ If this method returns zero or a negative number, the portlet
+ is permanently unavailable or cannot provide an estimate of
+ how long it will be unavailable.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>an integer specifying the number of seconds
+ the portlet will be temporarily unavailable,
+ or zero or a negative number if the portlet is permanently
+ unavailable or cannot make an estimate.</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=2 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> </TD>
+ <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="class-use/UnavailableException.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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-files/index-1.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>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/ValidatorException.html" title="class in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../index.html?javax/portlet/UnavailableException.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="UnavailableException.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | 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>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+
+</BODY>
+</HTML>
Propchange: portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/UnavailableException.html
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/ValidatorException.html
URL: http://svn.apache.org/viewvc/portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/ValidatorException.html?rev=709960&view=auto
==============================================================================
--- portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/ValidatorException.html (added)
+++ portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/ValidatorException.html Sun Nov 2 14:19:07 2008
@@ -0,0 +1,348 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0) on Wed Feb 06 17:53:07 CET 2008 -->
+<TITLE>
+ValidatorException
+</TITLE>
+
+<META NAME="keywords" CONTENT="javax.portlet.ValidatorException class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="ValidatorException";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_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> </TD>
+ <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="class-use/ValidatorException.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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-files/index-1.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>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/UnavailableException.html" title="class in javax.portlet"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/WindowState.html" title="class in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../index.html?javax/portlet/ValidatorException.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="ValidatorException.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | 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>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+javax.portlet</FONT>
+<BR>
+Class ValidatorException</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
+ <IMG SRC="../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
+ <IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">javax.portlet.PortletException</A>
+ <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.portlet.ValidatorException</B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public class <B>ValidatorException</B><DT>extends <A HREF="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</A></DL>
+</PRE>
+
+<P>
+The <CODE>ValidatorException</CODE> is thrown by the
+ <CODE>validate</CODE> method of a PreferencesValidator when
+ the validation of a preference failed.
+<P>
+
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../serialized-form.html#javax.portlet.ValidatorException">Serialized Form</A></DL>
+<HR>
+
+<P>
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../javax/portlet/ValidatorException.html#ValidatorException(java.lang.String, java.util.Collection)">ValidatorException</A></B>(java.lang.String text,
+ java.util.Collection<java.lang.String> failedKeys)</CODE>
+
+<BR>
+ Constructs a new validator exception with the given text.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../javax/portlet/ValidatorException.html#ValidatorException(java.lang.String, java.lang.Throwable, java.util.Collection)">ValidatorException</A></B>(java.lang.String text,
+ java.lang.Throwable cause,
+ java.util.Collection<java.lang.String> failedKeys)</CODE>
+
+<BR>
+ Constructs a new portlet validator exception.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../javax/portlet/ValidatorException.html#ValidatorException(java.lang.Throwable, java.util.Collection)">ValidatorException</A></B>(java.lang.Throwable cause,
+ java.util.Collection<java.lang.String> failedKeys)</CODE>
+
+<BR>
+ Constructs a new portlet validator exception when the portlet needs to throw an
+ exception.</TD>
+</TR>
+</TABLE>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.util.Enumeration<java.lang.String></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/ValidatorException.html#getFailedKeys()">getFailedKeys</A></B>()</CODE>
+
+<BR>
+ Returns the keys that failed the validation.</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="ValidatorException(java.lang.String, java.util.Collection)"><!-- --></A><H3>
+ValidatorException</H3>
+<PRE>
+public <B>ValidatorException</B>(java.lang.String text,
+ java.util.Collection<java.lang.String> failedKeys)</PRE>
+<DL>
+<DD>Constructs a new validator exception with the given text. The
+ portlet container may use the text write it to a log.
+ <p>
+ The collection of failed keys may contain all failed keys, only the
+ first key that failed validation, or may be <code>null</code>.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>text</CODE> - the exception text<DD><CODE>failedKeys</CODE> - keys that failed the validation; may be <code>null</code></DL>
+</DL>
+<HR>
+
+<A NAME="ValidatorException(java.lang.String, java.lang.Throwable, java.util.Collection)"><!-- --></A><H3>
+ValidatorException</H3>
+<PRE>
+public <B>ValidatorException</B>(java.lang.String text,
+ java.lang.Throwable cause,
+ java.util.Collection<java.lang.String> failedKeys)</PRE>
+<DL>
+<DD>Constructs a new portlet validator exception.
+ Used, when the portlet needs to do one of the following:
+ <ul>
+ <li>throw an exception
+ <li>include a message about the "root cause" that interfered
+ with its normal operation
+ <li>include a description message
+ </ul>
+ <p>
+ The Collection of failed keys may contain all failed keys, only the
+ first key that failed validation, or may be <code>null</code>.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>text</CODE> - the exception text<DD><CODE>cause</CODE> - the root cause<DD><CODE>failedKeys</CODE> - keys that failed the validation; may be <code>null</code></DL>
+</DL>
+<HR>
+
+<A NAME="ValidatorException(java.lang.Throwable, java.util.Collection)"><!-- --></A><H3>
+ValidatorException</H3>
+<PRE>
+public <B>ValidatorException</B>(java.lang.Throwable cause,
+ java.util.Collection<java.lang.String> failedKeys)</PRE>
+<DL>
+<DD>Constructs a new portlet validator exception when the portlet needs to throw an
+ exception. The exception message is based on the localized message
+ of the underlying exception.
+ <p>
+ The Collection of failed keys may contain all failed keys, only the
+ first key that failed validation, or may be <code>null</code>.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>cause</CODE> - the root cause<DD><CODE>failedKeys</CODE> - keys that failed the validation; may be <code>null</code></DL>
+</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="getFailedKeys()"><!-- --></A><H3>
+getFailedKeys</H3>
+<PRE>
+public java.util.Enumeration<java.lang.String> <B>getFailedKeys</B>()</PRE>
+<DL>
+<DD>Returns the keys that failed the validation.
+ <p>
+ The Enumeration of failed keys may contain all failed keys, only the
+ first key that failed validation, or an empty
+ <code>Enumeration</code> if no failed keys are available.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the keys that failed validation, or an empty
+ <code>Enumeration</code> if no failed keys are available.</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=2 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> </TD>
+ <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="class-use/ValidatorException.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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-files/index-1.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>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/UnavailableException.html" title="class in javax.portlet"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/WindowState.html" title="class in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../index.html?javax/portlet/ValidatorException.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="ValidatorException.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | 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>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+
+</BODY>
+</HTML>
Propchange: portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/ValidatorException.html
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/WindowState.html
URL: http://svn.apache.org/viewvc/portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/WindowState.html?rev=709960&view=auto
==============================================================================
--- portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/WindowState.html (added)
+++ portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/WindowState.html Sun Nov 2 14:19:07 2008
@@ -0,0 +1,428 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0) on Wed Feb 06 17:53:07 CET 2008 -->
+<TITLE>
+WindowState
+</TITLE>
+
+<META NAME="keywords" CONTENT="javax.portlet.WindowState class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="WindowState";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_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> </TD>
+ <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="class-use/WindowState.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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-files/index-1.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>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/ValidatorException.html" title="class in javax.portlet"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/WindowStateException.html" title="class in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../index.html?javax/portlet/WindowState.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="WindowState.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+javax.portlet</FONT>
+<BR>
+Class WindowState</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.portlet.WindowState</B>
+</PRE>
+<HR>
+<DL>
+<DT><PRE>public class <B>WindowState</B><DT>extends java.lang.Object</DL>
+</PRE>
+
+<P>
+The <CODE>WindowState</CODE> class represents
+ the possible window states that a portlet window can assume.
+ <P>
+ This class defines a standard set of the most basic portlet window states.
+ Additional window states may be defined by calling the constructor of
+ this class. If a portal/portlet-container does not support a
+ custom window state defined in the portlet application deployment descriptor,
+ the custom window state will be ignored by the portal/portlet container.
+<P>
+
+<P>
+<HR>
+
+<P>
+<!-- =========== FIELD SUMMARY =========== -->
+
+<A NAME="field_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Field Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static <A HREF="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/WindowState.html#MAXIMIZED">MAXIMIZED</A></B></CODE>
+
+<BR>
+ The <code>MAXIMIZED</code> window state is an indication
+ that a portlet may be the only portlet being rendered in the
+ portal page, or that the portlet has more space compared to other portlets
+ in the portal page.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static <A HREF="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/WindowState.html#MINIMIZED">MINIMIZED</A></B></CODE>
+
+<BR>
+ When a portlet is in <code>MINIMIZED</code> window state,
+ the portlet should only render minimal output or no output at all.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static <A HREF="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/WindowState.html#NORMAL">NORMAL</A></B></CODE>
+
+<BR>
+ The <code>NORMAL</code> window state indicates that a portlet
+ may be sharing the page with other portlets.</TD>
+</TR>
+</TABLE>
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../javax/portlet/WindowState.html#WindowState(java.lang.String)">WindowState</A></B>(java.lang.String name)</CODE>
+
+<BR>
+ Creates a new window state with the given name.</TD>
+</TR>
+</TABLE>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/WindowState.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object object)</CODE>
+
+<BR>
+ Compares the specified object with this window state
+ for equality.</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/WindowState.html#hashCode()">hashCode</A></B>()</CODE>
+
+<BR>
+ Returns the hash code value for this window state.</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/WindowState.html#toString()">toString</A></B>()</CODE>
+
+<BR>
+ Returns a String representation of this window state.</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+<A NAME="field_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Field Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="NORMAL"><!-- --></A><H3>
+NORMAL</H3>
+<PRE>
+public static final <A HREF="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</A> <B>NORMAL</B></PRE>
+<DL>
+<DD>The <code>NORMAL</code> window state indicates that a portlet
+ may be sharing the page with other portlets. It may also
+ indicate that the target device has limited display capabilities.
+ Therefore, a portlet should restrict the size of its rendered
+ output in this window state.
+ <p>
+ The string value for this state is <code>"normal"</code>.
+<P>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="MAXIMIZED"><!-- --></A><H3>
+MAXIMIZED</H3>
+<PRE>
+public static final <A HREF="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</A> <B>MAXIMIZED</B></PRE>
+<DL>
+<DD>The <code>MAXIMIZED</code> window state is an indication
+ that a portlet may be the only portlet being rendered in the
+ portal page, or that the portlet has more space compared to other portlets
+ in the portal page. A portlet may generate richer content
+ when its window state is <code>MAXIMIZED</code>.
+ <p>
+ The string value for this state is <code>"maximized"</code>.
+<P>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="MINIMIZED"><!-- --></A><H3>
+MINIMIZED</H3>
+<PRE>
+public static final <A HREF="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</A> <B>MINIMIZED</B></PRE>
+<DL>
+<DD>When a portlet is in <code>MINIMIZED</code> window state,
+ the portlet should only render minimal output or no output at all.
+ <p>
+ The string value for this state is <code>"minimized"</code>.
+<P>
+<DL>
+</DL>
+</DL>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="WindowState(java.lang.String)"><!-- --></A><H3>
+WindowState</H3>
+<PRE>
+public <B>WindowState</B>(java.lang.String name)</PRE>
+<DL>
+<DD>Creates a new window state with the given name.
+ <p>
+ Upper case letters in the name are converted to
+ lower case letters.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the window state</DL>
+</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="toString()"><!-- --></A><H3>
+toString</H3>
+<PRE>
+public java.lang.String <B>toString</B>()</PRE>
+<DL>
+<DD>Returns a String representation of this window state.
+ Window state names are always lower case names.
+<P>
+<DD><DL>
+<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>String representation of this window state.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="hashCode()"><!-- --></A><H3>
+hashCode</H3>
+<PRE>
+public int <B>hashCode</B>()</PRE>
+<DL>
+<DD>Returns the hash code value for this window state.
+ The hash code is constructed by producing the
+ hash value of the String value of this window state.
+<P>
+<DD><DL>
+<DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>hash code value for this window state</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
+equals</H3>
+<PRE>
+public boolean <B>equals</B>(java.lang.Object object)</PRE>
+<DL>
+<DD>Compares the specified object with this window state
+ for equality. Returns <code>true</code> if the
+ Strings <code>equals</code> method for the String
+ representing the two window states returns <code>true</code>.
+<P>
+<DD><DL>
+<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>object</CODE> - the window state to compare this window state with.
+<DT><B>Returns:</B><DD>true, if the specified object is equal with this window state.</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=2 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> </TD>
+ <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="class-use/WindowState.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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-files/index-1.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>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../javax/portlet/ValidatorException.html" title="class in javax.portlet"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/WindowStateException.html" title="class in javax.portlet"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../index.html?javax/portlet/WindowState.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="WindowState.html" target="_top"><B>NO FRAMES</B></A>
+ <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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+
+</BODY>
+</HTML>
Propchange: portals/pluto/branches/2.0-spi-refactoring/src/site/resources/portlet-2.0-apidocs/javax/portlet/WindowState.html
------------------------------------------------------------------------------
svn:keywords = Id