genericportlet.html.svn-base

portal越来越流行了

<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html" title="class in javax.portlet">UnavailableException</A></CODE> - if the portlet is unavailable to perform render at this
                time
<DD><CODE><A HREF="../../javax/portlet/PortletSecurityException.html" title="class in javax.portlet">PortletSecurityException</A></CODE> - if the portlet cannot fullfill this request because of
                security reasons
<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
</DD>
</DL>
<HR>

<A NAME="getPortletConfig()"><!-- --></A><H3>
getPortletConfig</H3>
<PRE>
public <A HREF="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</A> <B>getPortletConfig</B>()</PRE>
<DL>
<DD>Returns the PortletConfig object of this portlet.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the PortletConfig object of this portlet</DL>
</DD>
</DL>
<HR>

<A NAME="destroy()"><!-- --></A><H3>
destroy</H3>
<PRE>
public void <B>destroy</B>()</PRE>
<DL>
<DD>Called by the portlet container to indicate to a portlet that the portlet
 is being taken out of service.
 <p>
 The default implementation does nothing.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../javax/portlet/Portlet.html#destroy()">destroy</A></CODE> in interface <CODE><A HREF="../../javax/portlet/Portlet.html" title="interface in javax.portlet">Portlet</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getPortletName()"><!-- --></A><H3>
getPortletName</H3>
<PRE>
public java.lang.String <B>getPortletName</B>()</PRE>
<DL>
<DD>Returns the name of this portlet.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../javax/portlet/PortletConfig.html#getPortletName()">getPortletName</A></CODE> in interface <CODE><A HREF="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the portlet name<DT><B>See Also:</B><DD><A HREF="../../javax/portlet/PortletConfig.html#getPortletName()"><CODE>PortletConfig.getPortletName()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getPortletContext()"><!-- --></A><H3>
getPortletContext</H3>
<PRE>
public <A HREF="../../javax/portlet/PortletContext.html" title="interface in javax.portlet">PortletContext</A> <B>getPortletContext</B>()</PRE>
<DL>
<DD>Returns the <code>PortletContext</code> of the portlet application the
 portlet is in.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../javax/portlet/PortletConfig.html#getPortletContext()">getPortletContext</A></CODE> in interface <CODE><A HREF="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the portlet application context<DT><B>See Also:</B><DD><A HREF="../../javax/portlet/PortletContext.html" title="interface in javax.portlet"><CODE>PortletContext</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getResourceBundle(java.util.Locale)"><!-- --></A><H3>
getResourceBundle</H3>
<PRE>
public java.util.ResourceBundle <B>getResourceBundle</B>(java.util.Locale&nbsp;locale)</PRE>
<DL>
<DD>Gets the resource bundle for the given locale based on the resource
 bundle defined in the deployment descriptor with
 <code>resource-bundle</code> tag or the inlined resources defined in
 the deployment descriptor.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../javax/portlet/PortletConfig.html#getResourceBundle(java.util.Locale)">getResourceBundle</A></CODE> in interface <CODE><A HREF="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locale</CODE> - the locale for which to retrieve the resource bundle
<DT><B>Returns:</B><DD>the resource bundle for the given locale</DL>
</DD>
</DL>
<HR>

<A NAME="getInitParameter(java.lang.String)"><!-- --></A><H3>
getInitParameter</H3>
<PRE>
public java.lang.String <B>getInitParameter</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Returns a String containing the value of the named initialization        * parameter, or null if the parameter does not exist.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../javax/portlet/PortletConfig.html#getInitParameter(java.lang.String)">getInitParameter</A></CODE> in interface <CODE><A HREF="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - a <code>String</code> specifying the name of the
            initialization parameter
<DT><B>Returns:</B><DD>a <code>String</code> containing the value of the
         initialization parameter
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if name is <code>null</code>.</DL>
</DD>
</DL>
<HR>

<A NAME="getInitParameterNames()"><!-- --></A><H3>
getInitParameterNames</H3>
<PRE>
public java.util.Enumeration&lt;java.lang.String&gt; <B>getInitParameterNames</B>()</PRE>
<DL>
<DD>Returns the names of the portlet initialization parameters as an
 Enumeration of String objects, or an empty Enumeration if the portlet has
 no initialization parameters.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../javax/portlet/PortletConfig.html#getInitParameterNames()">getInitParameterNames</A></CODE> in interface <CODE><A HREF="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an <code>Enumeration</code> of <code>String</code> objects
         containing the names of the portlet initialization parameters, or
         an empty Enumeration if the portlet has no initialization
         parameters.</DL>
</DD>
</DL>
<HR>

<A NAME="getProcessingEventQNames()"><!-- --></A><H3>
getProcessingEventQNames</H3>
<PRE>
public java.util.Enumeration&lt;javax.xml.namespace.QName&gt; <B>getProcessingEventQNames</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../javax/portlet/PortletConfig.html#getProcessingEventQNames()">PortletConfig</A></CODE></B></DD>
<DD>Returns the QNames of the processing events supported by the portlet
 as an <code>Enumeration</code> of <code>QName</code> objects, 
 or an empty <code>Enumeration</code> if the 
 portlet has not defined any processing events.    
 <p>
 Processing events are defined in the portlet deployment descriptor
 with the <code>supported-processing-event</code> element.    
 <p>
 If the event was defined using the <code>name</code> element instead of 
 the <code>qname</code> element the defined default namespace 
 is added as namespace for the returned QName.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../javax/portlet/PortletConfig.html#getProcessingEventQNames()">getProcessingEventQNames</A></CODE> in interface <CODE><A HREF="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an <code>Enumeration</code> of <code>QName</code> 
                        objects containing the names of the processing events, 
                        or an empty <code>Enumeration</code> if the 
                    portlet has not defined any support for processing events in
                    the deployment descriptor.</DL>
</DD>
</DL>
<HR>

<A NAME="getPublishingEventQNames()"><!-- --></A><H3>
getPublishingEventQNames</H3>
<PRE>
public java.util.Enumeration&lt;javax.xml.namespace.QName&gt; <B>getPublishingEventQNames</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../javax/portlet/PortletConfig.html#getPublishingEventQNames()">PortletConfig</A></CODE></B></DD>
<DD>Returns the QNames of the publishing events supported by the portlet
 as an <code>Enumeration</code> of <code>QName</code> objects, 
 or an empty <code>Enumeration</code> if the 
 portlet has not defined any publishing events.    
 <p>
 Publishing events are defined in the portlet deployment descriptor
 with the <code>supported-publishing-event</code> element.    
 <p>
 Note that this call does not return any events published that have not been
 declared in the deployment descriptor as supported.
 <p>
 If the event was defined using the <code>name</code> element instead of 
 the <code>qname</code> element the defined default namespace 
 is added as namespace for the returned QName.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../javax/portlet/PortletConfig.html#getPublishingEventQNames()">getPublishingEventQNames</A></CODE> in interface <CODE><A HREF="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an <code>Enumeration</code> of <code>QName</code> 
                        objects containing the names of the publishing events, 
                        or an empty <code>Enumeration</code> if the 
                    portlet has not defined any support for publishing events in
                    the deployment descriptor.</DL>
</DD>
</DL>
<HR>

<A NAME="getSupportedLocales()"><!-- --></A><H3>
getSupportedLocales</H3>
<PRE>
public java.util.Enumeration&lt;java.util.Locale&gt; <B>getSupportedLocales</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../javax/portlet/PortletConfig.html#getSupportedLocales()">PortletConfig</A></CODE></B></DD>
<DD>Returns the locales supported by the portlet
 as an <code>Enumeration</code> of <code>Locale</code> objects, 
 or an empty <code>Enumeration</code> if the 
 portlet has not defined any supported locales.    
 <p>
 Supported locales are defined in the portlet deployment descriptor
 with the <code>supported-locale</code> element.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../javax/portlet/PortletConfig.html#getSupportedLocales()">getSupportedLocales</A></CODE> in interface <CODE><A HREF="../../javax/portlet/PortletConfig.html" title="interface in javax.portlet">PortletConfig</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an <code>Enumeration</code> of <code>Locale</code> 
                        objects containing the supported locales, 
                        or an empty <code>Enumeration</code> if the 
                    portlet has not defined any supported locales in
                    the deployment descriptor.</DL>
</DD>
</DL>
<HR>

<A NAME="getContainerRuntimeOptions()"><!-- --></A><H3>
getContainerRuntimeOptions</H3>
<PRE>
public java.util.Map&lt;java.lang.String,java.lang.String[]&gt; <B>getContainerRuntimeOptions</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../javax/portlet/PortletConfig.html#getContainerRuntimeOptions()">PortletConfig</A></CODE></B></DD>
<DD>Returns the container runtime options
 and values for this portlet.
 <p>
 The portlet can set container runtime
 options in the <code>portlet.xml</code> via the
 <code>container-runtime-option</code> element with a name and a
 value on the application and portlet level.<br>
 If a container runtime option is set on the portlet application 
 level and on the portlet level with the same name the setting 
 on the portlet level takes precedence and overwrites the one