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 [5/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/PortletMode.html
URL: http://svn.apache.org/viewvc/portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletMode.html?rev=657263&view=auto
==============================================================================
--- portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletMode.html (added)
+++ portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletMode.html Fri May 16 17:57:32 2008
@@ -0,0 +1,375 @@
+<!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 PortletMode
+</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/GenericPortlet.html"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/PortletSessionUtil.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="PortletMode.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | <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>
+<!-- =========== END OF NAVBAR =========== -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+javax.portlet</FONT>
+<BR>
+Class PortletMode</H2>
+<PRE>
+java.lang.Object
+ |
+ +--<B>javax.portlet.PortletMode</B>
+</PRE>
+<HR>
+<DL>
+<DT>public class <B>PortletMode</B><DT>extends java.lang.Object</DL>
+
+<P>
+The <CODE>PortletMode</CODE> class represents
+ the possible modes that a portlet can assume.
+ <P>
+ A portlet mode indicates the function a portlet is performing.
+ Normally, portlets perform different tasks and create different
+ content depending on the function they are currently performing.
+ When invoking a portlet, the portlet container provides the
+ current portlet mode to the portlet.
+ <p>
+ Portlets can programmatically change their portlet
+ mode when processing an action request.
+ <P>
+ This class defines the default portlet modes <code>EDIT, HELP, VIEW</code>.
+ Additional portlet modes may be defined by calling the constructor
+ of this class. If a portal/portlet-container does not support a
+ custom portlet mode defined in the portlet application deployment descriptor,
+ the custom portlet mode will be ignored by the portal/portlet container.
+<P>
+<HR>
+
+<P>
+<!-- ======== INNER CLASS SUMMARY ======== -->
+
+
+<!-- =========== FIELD SUMMARY =========== -->
+
+<A NAME="field_summary"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=2><FONT SIZE="+2">
+<B>Field Summary</B></FONT></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static <A HREF="../../javax/portlet/PortletMode.html">PortletMode</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletMode.html#EDIT">EDIT</A></B></CODE>
+
+<BR>
+ Within the <code>EDIT</code> portlet mode, a portlet should provide
+ content and logic that lets a user customize the behavior of the portlet.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static <A HREF="../../javax/portlet/PortletMode.html">PortletMode</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletMode.html#HELP">HELP</A></B></CODE>
+
+<BR>
+ When in <code>HELP</code> portlet mode, a portlet should provide help
+ information about the portlet.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static <A HREF="../../javax/portlet/PortletMode.html">PortletMode</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletMode.html#VIEW">VIEW</A></B></CODE>
+
+<BR>
+ The expected functionality for a portlet in <code>VIEW</code> portlet mode
+ is to generate markup reflecting the current state of the portlet.</TD>
+</TR>
+</TABLE>
+
+<!-- ======== 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/PortletMode.html#PortletMode(java.lang.String)">PortletMode</A></B>(java.lang.String name)</CODE>
+
+<BR>
+ Creates a new portlet mode with the given name.</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> boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletMode.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object object)</CODE>
+
+<BR>
+ Compares the specified object with this portlet mode
+ 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/PortletMode.html#hashCode()">hashCode</A></B>()</CODE>
+
+<BR>
+ Returns the hash code value for this portlet 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/PortletMode.html#toString()">toString</A></B>()</CODE>
+
+<BR>
+ Returns a String representation of this portlet mode.</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, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
+</TR>
+</TABLE>
+
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+<A NAME="field_detail"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TD COLSPAN=1><FONT SIZE="+2">
+<B>Field Detail</B></FONT></TD>
+</TR>
+</TABLE>
+
+<A NAME="VIEW"><!-- --></A><H3>
+VIEW</H3>
+<PRE>
+public static final <A HREF="../../javax/portlet/PortletMode.html">PortletMode</A> <B>VIEW</B></PRE>
+<DL>
+<DD>The expected functionality for a portlet in <code>VIEW</code> portlet mode
+ is to generate markup reflecting the current state of the portlet.
+ For example, the <code>VIEW</code> portlet mode of a portlet may
+ include one or more screens that the user can navigate and interact
+ with, or it may consist of static content that does not require any
+ user interaction.
+ <P>
+ This mode must be supported by the portlet.
+ <p>
+ The string value for this mode is <code>"view"</code>.</DL>
+<HR>
+
+<A NAME="EDIT"><!-- --></A><H3>
+EDIT</H3>
+<PRE>
+public static final <A HREF="../../javax/portlet/PortletMode.html">PortletMode</A> <B>EDIT</B></PRE>
+<DL>
+<DD>Within the <code>EDIT</code> portlet mode, a portlet should provide
+ content and logic that lets a user customize the behavior of the portlet.
+ The EDIT portlet mode may include one or more screens among which
+ users can navigate to enter their customization data.
+ <p>
+ Typically, portlets in <code>EDIT</code> portlet mode will
+ set or update portlet preferences.
+ <P>
+ This mode is optional.
+ <p>
+ The string value for this mode is <code>"edit"</code>.</DL>
+<HR>
+
+<A NAME="HELP"><!-- --></A><H3>
+HELP</H3>
+<PRE>
+public static final <A HREF="../../javax/portlet/PortletMode.html">PortletMode</A> <B>HELP</B></PRE>
+<DL>
+<DD>When in <code>HELP</code> portlet mode, a portlet should provide help
+ information about the portlet. This help information could be
+ a simple help screen explaining the entire portlet in
+ coherent text or it could be context-sensitive help.
+ <P>
+ This mode is optional.
+ <p>
+ The string value for this mode is <code>"help"</code>.</DL>
+
+<!-- ========= 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="PortletMode(java.lang.String)"><!-- --></A><H3>
+PortletMode</H3>
+<PRE>
+public <B>PortletMode</B>(java.lang.String name)</PRE>
+<DL>
+<DD>Creates a new portlet mode with the given name.
+ <p>
+ Upper case letters in the name are converted to
+ lower case letters.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the portlet mode</DL>
+</DD>
+</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="toString()"><!-- --></A><H3>
+toString</H3>
+<PRE>
+public java.lang.String <B>toString</B>()</PRE>
+<DL>
+<DD>Returns a String representation of this portlet mode.
+ Portlet mode names are always lower case names.<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 portlet mode</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 portlet mode.
+ The hash code is constructed by producing the
+ hash value of the String value of this mode.<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 portlet mode</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 portlet mode
+ for equality. Returns <code>true</code> if the
+ Strings <code>equals</code> method for the String
+ representing the two portlet modes returns <code>true</code>.<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>the</CODE> - portlet mode to compare this portlet mode with<DT><B>Returns:</B><DD>true, if the specified object is equal with this portlet mode</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/GenericPortlet.html"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/PortletSessionUtil.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="PortletMode.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: INNER | <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>
+<!-- =========== 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/PortletMode.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletMode.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletModeException.html
URL: http://svn.apache.org/viewvc/portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletModeException.html?rev=657263&view=auto
==============================================================================
--- portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletModeException.html (added)
+++ portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletModeException.html Fri May 16 17:57:32 2008
@@ -0,0 +1,307 @@
+<!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 PortletModeException
+</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/PortletException.html"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/PortletSecurityException.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="PortletModeException.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 PortletModeException</H2>
+<PRE>
+java.lang.Object
+ |
+ +--java.lang.Throwable
+ |
+ +--java.lang.Exception
+ |
+ +--<A HREF="../../javax/portlet/PortletException.html">javax.portlet.PortletException</A>
+ |
+ +--<B>javax.portlet.PortletModeException</B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
+</DL>
+<HR>
+<DL>
+<DT>public class <B>PortletModeException</B><DT>extends <A HREF="../../javax/portlet/PortletException.html">PortletException</A></DL>
+
+<P>
+The <CODE>PortletModeException</CODE> is thrown when a portlet
+ tries to use or set a portlet mode that is not supported by the current
+ runtime environment or the portlet.
+<P>
+<DL>
+<DT><B>See Also: </B><DD><A HREF="../../serialized-form.html#javax.portlet.PortletModeException">Serialized Form</A></DL>
+<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/PortletModeException.html#PortletModeException(java.lang.String, javax.portlet.PortletMode)">PortletModeException</A></B>(java.lang.String text,
+ <A HREF="../../javax/portlet/PortletMode.html">PortletMode</A> mode)</CODE>
+
+<BR>
+ Constructs a new portlet mode exception with the given text and the
+ portlet mode that caused this exception.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../javax/portlet/PortletModeException.html#PortletModeException(java.lang.String, java.lang.Throwable, javax.portlet.PortletMode)">PortletModeException</A></B>(java.lang.String text,
+ java.lang.Throwable cause,
+ <A HREF="../../javax/portlet/PortletMode.html">PortletMode</A> mode)</CODE>
+
+<BR>
+ Constructs a new portlet mode exception when the portlet needs to do
+ the following:
+
+ <il>throw an exception
+ include a message about the "root cause" that interfered
+ with its normal operation
+ include a description message
+ include the portlet mode that caused this exception
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../javax/portlet/PortletModeException.html#PortletModeException(java.lang.Throwable, javax.portlet.PortletMode)">PortletModeException</A></B>(java.lang.Throwable cause,
+ <A HREF="../../javax/portlet/PortletMode.html">PortletMode</A> mode)</CODE>
+
+<BR>
+ Constructs a new portlet mode exception when the portlet needs to throw an
+ exception.</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> <A HREF="../../javax/portlet/PortletMode.html">PortletMode</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletModeException.html#getMode()">getMode</A></B>()</CODE>
+
+<BR>
+ Returns the unsupported portlet mode causing this exception.</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_javax.portlet.PortletException"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TD><B>Methods inherited from class javax.portlet.<A HREF="../../javax/portlet/PortletException.html">PortletException</A></B></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A HREF="../../javax/portlet/PortletException.html#getCause()">getCause</A>, <A HREF="../../javax/portlet/PortletException.html#printStackTrace()">printStackTrace</A>, <A HREF="../../javax/portlet/PortletException.html#printStackTrace(java.io.PrintStream)">printStackTrace</A>, <A HREF="../../javax/portlet/PortletException.html#printStackTrace(java.io.PrintWriter)">printStackTrace</A></CODE></TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
+<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TD><B>Methods inherited from class java.lang.Throwable</B></TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE>fillInStackTrace, getLocalizedMessage, getMessage, toString</CODE></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, 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="PortletModeException(java.lang.String, javax.portlet.PortletMode)"><!-- --></A><H3>
+PortletModeException</H3>
+<PRE>
+public <B>PortletModeException</B>(java.lang.String text,
+ <A HREF="../../javax/portlet/PortletMode.html">PortletMode</A> mode)</PRE>
+<DL>
+<DD>Constructs a new portlet mode exception with the given text and the
+ portlet mode that caused this exception. The
+ portlet container may use the text and portlet mode write it to a log.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>text</CODE> - the exception text<DD><CODE>mode</CODE> - the mode causing the exception</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="PortletModeException(java.lang.String, java.lang.Throwable, javax.portlet.PortletMode)"><!-- --></A><H3>
+PortletModeException</H3>
+<PRE>
+public <B>PortletModeException</B>(java.lang.String text,
+ java.lang.Throwable cause,
+ <A HREF="../../javax/portlet/PortletMode.html">PortletMode</A> mode)</PRE>
+<DL>
+<DD>Constructs a new portlet mode exception when the portlet needs to do
+ the following:
+ <ul>
+ <il>throw an exception
+ <li>include a message about the "root cause" that interfered
+ with its normal operation
+ <li>include a description message
+ <li>include the portlet mode that caused this exception
+ </ul><DD><DL>
+<DT><B>Parameters:</B><DD><CODE>text</CODE> - the exception text<DD><CODE>cause</CODE> - the root cause<DD><CODE>mode</CODE> - the mode causing the exception</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="PortletModeException(java.lang.Throwable, javax.portlet.PortletMode)"><!-- --></A><H3>
+PortletModeException</H3>
+<PRE>
+public <B>PortletModeException</B>(java.lang.Throwable cause,
+ <A HREF="../../javax/portlet/PortletMode.html">PortletMode</A> mode)</PRE>
+<DL>
+<DD>Constructs a new portlet mode exception when the portlet needs to throw an
+ exception. The exception message is based on the localized message
+ of the underlying exception and the portlet mode that caused this exception.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>cause</CODE> - the root cause<DD><CODE>mode</CODE> - the mode causing the exception</DL>
+</DD>
+</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="getMode()"><!-- --></A><H3>
+getMode</H3>
+<PRE>
+public <A HREF="../../javax/portlet/PortletMode.html">PortletMode</A> <B>getMode</B>()</PRE>
+<DL>
+<DD>Returns the unsupported portlet mode causing this exception.<DD><DL>
+<DT><B>Returns:</B><DD>the portlet mode that caused this exception</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/PortletException.html"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/PortletSecurityException.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="PortletModeException.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/PortletModeException.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletModeException.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletPreferences.html
URL: http://svn.apache.org/viewvc/portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletPreferences.html?rev=657263&view=auto
==============================================================================
--- portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletPreferences.html (added)
+++ portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletPreferences.html Fri May 16 17:57:32 2008
@@ -0,0 +1,442 @@
+<!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 PortletPreferences
+</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/PortletContext.html"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/PortletRequest.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="PortletPreferences.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 PortletPreferences</H2>
+<HR>
+<DL>
+<DT>public interface <B>PortletPreferences</B></DL>
+
+<P>
+The <CODE>PortletPreferences</CODE> interface allows the portlet to store
+ configuration data. It is not the
+ purpose of this interface to replace general purpose databases.
+ <p>
+ There are two different types of preferences:
+ <ul>
+ <li>modifiable preferences - these preferences can be changed by the
+ portlet in any standard portlet mode (<code>EDIT, HELP, VIEW</code>).
+ Per default every preference is modifiable.
+ <li>read-only preferences - these preferences cannot be changed by the
+ portlet in any standard portlet mode, but may be changed by administrative modes.
+ Preferences are read-only, if the are defined in the
+ deployment descriptor with <code>read-only</code> set to <code>true</code>,
+ or if the portlet container restricts write access.
+ </ul>
+ <p>
+ Changes are persisted when the <code>store</code> method is called. The <code>store</code> method
+ can only be invoked within the scope of a <code>processAction</code> call.
+ Changes that are not persisted are discarded when the
+ <code>processAction</code> or <code>render</code> method ends.
+<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.util.Map</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../javax/portlet/PortletPreferences.html#getMap()">getMap</A></B>()</CODE>
+
+<BR>
+ Returns a <code>Map</code> of the preferences.</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/PortletPreferences.html#getNames()">getNames</A></B>()</CODE>
+
+<BR>
+ Returns all of the keys that have an associated value,
+ or an empty <code>Enumeration</code> if no keys are
+ available.</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/PortletPreferences.html#getValue(java.lang.String, java.lang.String)">getValue</A></B>(java.lang.String key,
+ java.lang.String def)</CODE>
+
+<BR>
+ Returns the first String value associated with the specified key of this preference.</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/PortletPreferences.html#getValues(java.lang.String, java.lang.String[])">getValues</A></B>(java.lang.String key,
+ java.lang.String[] def)</CODE>
+
+<BR>
+ Returns the String array value associated with the specified key in this preference.</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/PortletPreferences.html#isReadOnly(java.lang.String)">isReadOnly</A></B>(java.lang.String key)</CODE>
+
+<BR>
+ Returns true, if the value of this key cannot be modified by the user.</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/PortletPreferences.html#reset(java.lang.String)">reset</A></B>(java.lang.String key)</CODE>
+
+<BR>
+ Resets or removes the value associated with the specified key.</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/PortletPreferences.html#setValue(java.lang.String, java.lang.String)">setValue</A></B>(java.lang.String key,
+ java.lang.String value)</CODE>
+
+<BR>
+ Associates the specified String value with the specified key in this
+ preference.</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/PortletPreferences.html#setValues(java.lang.String, java.lang.String[])">setValues</A></B>(java.lang.String key,
+ java.lang.String[] values)</CODE>
+
+<BR>
+ Associates the specified String array value with the specified key in this
+ preference.</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/PortletPreferences.html#store()">store</A></B>()</CODE>
+
+<BR>
+ Commits all changes made to the preferences via the
+ <code>set</code> methods in the persistent store.</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="isReadOnly(java.lang.String)"><!-- --></A><H3>
+isReadOnly</H3>
+<PRE>
+public boolean <B>isReadOnly</B>(java.lang.String key)</PRE>
+<DL>
+<DD>Returns true, if the value of this key cannot be modified by the user.
+ <p>
+ Modifiable preferences can be changed by the
+ portlet in any standard portlet mode (<code>EDIT, HELP, VIEW</code>).
+ Per default every preference is modifiable.
+ <p>
+ Read-only preferences cannot be changed by the
+ portlet in any standard portlet mode, but inside of custom modes
+ it may be allowed changing them.
+ Preferences are read-only, if they are defined in the
+ deployment descriptor with <code>read-only</code> set to <code>true</code>,
+ or if the portlet container restricts write access.<DD><DL>
+<DT><B>Returns:</B><DD>false, if the value of this key can be changed, or
+ if the key is not known<DT><B>Throws:</B><DD><CODE>java.lang.IllegalArgumentException</CODE> - if <code>key</code> is <code>null</code>.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getValue(java.lang.String, java.lang.String)"><!-- --></A><H3>
+getValue</H3>
+<PRE>
+public java.lang.String <B>getValue</B>(java.lang.String key,
+ java.lang.String def)</PRE>
+<DL>
+<DD>Returns the first String value associated with the specified key of this preference.
+ If there is one or more preference values associated with the given key
+ it returns the first associated value.
+ If there are no preference values associated with the given key, or the
+ backing preference database is unavailable, it returns the given
+ default value.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - key for which the associated value is to be returned<DD><CODE>def</CODE> - the value to be returned in the event that there is no
+ value available associated with this <code>key</code>.<DT><B>Returns:</B><DD>the value associated with <code>key</code>, or <code>def</code>
+ if no value is associated with <code>key</code>, or the backing
+ store is inaccessible.<DT><B>Throws:</B><DD><CODE>java.lang.IllegalArgumentException</CODE> - if <code>key</code> is <code>null</code>. (A
+ <code>null</code> value for <code>def</code> <i>is</i> permitted.)<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/PortletPreferences.html#getValues(java.lang.String, java.lang.String[])"><CODE>getValues(String, String[])</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getValues(java.lang.String, java.lang.String[])"><!-- --></A><H3>
+getValues</H3>
+<PRE>
+public java.lang.String[] <B>getValues</B>(java.lang.String key,
+ java.lang.String[] def)</PRE>
+<DL>
+<DD>Returns the String array value associated with the specified key in this preference.
+
+ <p>Returns the specified default if there is no value
+ associated with the key, or if the backing store is inaccessible.
+
+ <p>If the implementation supports <i>stored defaults</i> and such a
+ default exists and is accessible, it is used in favor of the
+ specified default.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - key for which associated value is to be returned.<DD><CODE>def</CODE> - the value to be returned in the event that this
+ preference node has no value associated with <code>key</code>
+ or the associated value cannot be interpreted as a String array,
+ or the backing store is inaccessible.<DT><B>Returns:</B><DD>the String array value associated with
+ <code>key</code>, or <code>def</code> if the
+ associated value does not exist.<DT><B>Throws:</B><DD><CODE>java.lang.IllegalArgumentException</CODE> - if <code>key</code> is <code>null</code>. (A
+ <code>null</code> value for <code>def</code> <i>is</i> permitted.)<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/PortletPreferences.html#getValue(java.lang.String, java.lang.String)"><CODE>getValue(String,String)</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setValue(java.lang.String, java.lang.String)"><!-- --></A><H3>
+setValue</H3>
+<PRE>
+public void <B>setValue</B>(java.lang.String key,
+ java.lang.String value)
+ throws <A HREF="../../javax/portlet/ReadOnlyException.html">ReadOnlyException</A></PRE>
+<DL>
+<DD>Associates the specified String value with the specified key in this
+ preference.
+ <p>
+ The key cannot be <code>null</code>, but <code>null</code> values
+ for the value parameter are allowed.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - key with which the specified value is to be associated.<DD><CODE>value</CODE> - value to be associated with the specified key.<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/portlet/ReadOnlyException.html">ReadOnlyException</A></CODE> - if this preference cannot be modified for this request<DD><CODE>java.lang.IllegalArgumentException</CODE> - if key is <code>null</code>,
+ or <code>key.length()</code>
+ or <code>value.length</code> are to long. The maximum length
+ for key and value are implementation specific.<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/PortletPreferences.html#setValues(java.lang.String, java.lang.String[])"><CODE>setValues(String, String[])</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setValues(java.lang.String, java.lang.String[])"><!-- --></A><H3>
+setValues</H3>
+<PRE>
+public void <B>setValues</B>(java.lang.String key,
+ java.lang.String[] values)
+ throws <A HREF="../../javax/portlet/ReadOnlyException.html">ReadOnlyException</A></PRE>
+<DL>
+<DD>Associates the specified String array value with the specified key in this
+ preference.
+ <p>
+ The key cannot be <code>null</code>, but <code>null</code> values
+ in the values parameter are allowed.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - key with which the value is to be associated<DD><CODE>values</CODE> - values to be associated with key<DT><B>Throws:</B><DD><CODE>java.lang.IllegalArgumentException</CODE> - if key is <code>null</code>, or
+ <code>key.length()</code>
+ is to long or <code>value.size</code> is to large. The maximum
+ length for key and maximum size for value are implementation specific.<DD><CODE><A HREF="../../javax/portlet/ReadOnlyException.html">ReadOnlyException</A></CODE> - if this preference cannot be modified for this request<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/PortletPreferences.html#setValue(java.lang.String, java.lang.String)"><CODE>setValue(String,String)</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getNames()"><!-- --></A><H3>
+getNames</H3>
+<PRE>
+public java.util.Enumeration <B>getNames</B>()</PRE>
+<DL>
+<DD>Returns all of the keys that have an associated value,
+ or an empty <code>Enumeration</code> if no keys are
+ available.<DD><DL>
+<DT><B>Returns:</B><DD>an Enumeration of the keys that have an associated value,
+ or an empty <code>Enumeration</code> if no keys are
+ available.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMap()"><!-- --></A><H3>
+getMap</H3>
+<PRE>
+public java.util.Map <B>getMap</B>()</PRE>
+<DL>
+<DD>Returns a <code>Map</code> of the preferences.
+ <p>
+ The values in the returned <code>Map</code> are from type
+ String array (<code>String[]</code>).
+ <p>
+ If no preferences exist this method returns an empty <code>Map</code>.<DD><DL>
+<DT><B>Returns:</B><DD>an immutable <code>Map</code> containing preference names as
+ keys and preference values as map values, or an empty <code>Map</code>
+ if no preference exist. The keys in the preference
+ map are of type String. The values in the preference map are of type
+ String array (<code>String[]</code>).</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="reset(java.lang.String)"><!-- --></A><H3>
+reset</H3>
+<PRE>
+public void <B>reset</B>(java.lang.String key)
+ throws <A HREF="../../javax/portlet/ReadOnlyException.html">ReadOnlyException</A></PRE>
+<DL>
+<DD>Resets or removes the value associated with the specified key.
+ <p>
+ If this implementation supports stored defaults, and there is such
+ a default for the specified preference, the given key will be
+ reset to the stored default.
+ <p>
+ If there is no default available the key will be removed.<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - to reset<DT><B>Throws:</B><DD><CODE>java.lang.IllegalArgumentException</CODE> - if key is <code>null</code>.<DD><CODE><A HREF="../../javax/portlet/ReadOnlyException.html">ReadOnlyException</A></CODE> - if this preference cannot be modified for this request</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="store()"><!-- --></A><H3>
+store</H3>
+<PRE>
+public void <B>store</B>()
+ throws java.io.IOException,
+ <A HREF="../../javax/portlet/ValidatorException.html">ValidatorException</A></PRE>
+<DL>
+<DD>Commits all changes made to the preferences via the
+ <code>set</code> methods in the persistent store.
+ <P>
+ If this call returns succesfull, all changes are made
+ persistent. If this call fails, no changes are made
+ in the persistent store. This call is an atomic operation
+ regardless of how many preference attributes have been modified.
+ <P>
+ All changes made to preferences not followed by a call
+ to the <code>store</code> method are discarded when the
+ portlet finishes the <code>processAction</code> method.
+ <P>
+ If a validator is defined for this preferences in the
+ deployment descriptor, this validator is called before
+ the actual store is performed to check wether the given
+ preferences are vaild. If this check fails a
+ <code>ValidatorException</code> is thrown.<DD><DL>
+<DT><B>Throws:</B><DD><CODE>java.io.IOException</CODE> - if changes cannot be written into
+ the backend store<DD><CODE><A HREF="../../javax/portlet/ValidatorException.html">ValidatorException</A></CODE> - if the validation performed by the
+ associated validator fails<DD><CODE>java.lang.IllegalStateException</CODE> - if this method is called inside a render call<DT><B>See Also: </B><DD><A HREF="../../javax/portlet/PreferencesValidator.html"><CODE>PreferencesValidator</CODE></A></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/PortletContext.html"><B>PREV CLASS</B></A>
+ <A HREF="../../javax/portlet/PortletRequest.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="PortletPreferences.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/PortletPreferences.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/pluto/branches/pluto-1.1.x/src/site/resources/portlet-1.0-apidocs/javax/portlet/PortletPreferences.html
------------------------------------------------------------------------------
svn:mime-type = text/html