Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ResourceURL.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ResourceURL.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ResourceURL.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/ResourceURL.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,431 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Thu Jul 16 17:20:27 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ResourceURL (Java Portlet Specification V2.1.0 1.0 API)</title> +<meta name="date" content="2015-07-16"> +<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ResourceURL (Java Portlet Specification V2.1.0 1.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ResourceURL.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../index-all.html">Index</a></li> +<li><a href="../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../javax/portlet/ResourceServingPortlet.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/ResourceURL.html" target="_top">Frames</a></li> +<li><a href="ResourceURL.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">javax.portlet</div> +<h2 title="Interface ResourceURL" class="title">Interface ResourceURL</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../javax/portlet/BaseURL.html" title="interface in javax.portlet">BaseURL</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ResourceURL</span> +extends <a href="../../javax/portlet/BaseURL.html" title="interface in javax.portlet">BaseURL</a></pre> +<div class="block">The <CODE>ResourceURL</CODE> defines a resource URL that when clicked will + result in a <code>serveResource</code> call of the + <code>ResourceServingPortlet</code> interface. + <p> + Each resource URL has a specific cache level assigned with it. This level + can be either <code>FULL, PORTLET</code> or <code>PAGE</code> and denotes + the cacheability of the resource in the browser. + <p> + The default cache level of a resource URL is either the cache level of the + parent resource URL, or <code>PAGE</code> if no parent resource URL is + available.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ResourceURL.html#FULL">FULL</a></strong></code> +<div class="block">The URL of type <code>FULL</code> does not need to contain the current + state of the page or the current render parameters, portlet mode, or + window state of the portlet.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ResourceURL.html#PAGE">PAGE</a></strong></code> +<div class="block">The URL of type <code>PAGE</code> may contain artifacts that require + knowledge of the state of the complete page, like + <code>PortletURLs</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ResourceURL.html#PORTLET">PORTLET</a></strong></code> +<div class="block">The URL of type <code>PORTLRET</code> does not need to contain the + current state of the page, but the current render parameters, portlet + mode, or window state of the portlet must be accessible to the portlet.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ResourceURL.html#SHARED">SHARED</a></strong></code> +<div class="block">Property that the portlet can set for resources with caching + type <code>FULL</code> via the <code>setProperty</code> method + on the <code>ResourceURL</code>.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ResourceURL.html#getCacheability()">getCacheability</a></strong>()</code> +<div class="block">Returns the cache level of this resource URL.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ResourceURL.html#setCacheability(java.lang.String)">setCacheability</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> cacheLevel)</code> +<div class="block">Sets the cache level of this resource URL.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/ResourceURL.html#setResourceID(java.lang.String)">setResourceID</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> resourceID)</code> +<div class="block">Allows setting a resource ID that can be retrieved when serving the + resource through the <a href="../../javax/portlet/ResourceRequest.html#getResourceID()"><code>ResourceRequest.getResourceID()</code></a> method.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_javax.portlet.BaseURL"> +<!-- --> +</a> +<h3>Methods inherited from interface javax.portlet.<a href="../../javax/portlet/BaseURL.html" title="interface in javax.portlet">BaseURL</a></h3> +<code><a href="../../javax/portlet/BaseURL.html#addProperty(java.lang.String,%20java.lang.String)">addProperty</a>, <a href="../../javax/portlet/BaseURL.html#getParameterMap()">getParameterMap</a>, <a href="../../javax/portlet/BaseURL.html#setParameter(java.lang.String,%20java.lang.String)">setParameter</a>, <a href="../../javax/portlet/BaseURL.html#setParameter(java.lang.String,%20java.lang.String[])">setParameter</a>, <a href="../../javax/portlet/BaseURL.html#setParameters(java.util.Map)">setParameters</a>, <a href="../../javax/portlet/BaseURL.html#setProperty(java.lang.String,%20java.lang.String)">setProperty</a>, <a href="../../javax/portlet/BaseURL.html#setSecure(boolean)">setSecure</a>, <a href="../../javax/portlet/BaseURL.html#toString()">toString</a>, <a href="../../javax/portlet/BaseURL.html#write(java.io.Writer)">write</a>, <a href="../../javax/portlet/BaseURL.html#write(java.io.Writer,%20boolean)">write</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="FULL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FULL</h4> +<pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> FULL</pre> +<div class="block">The URL of type <code>FULL</code> does not need to contain the current + state of the page or the current render parameters, portlet mode, or + window state of the portlet. Thus the portlet may not be able to + access the portlet mode, window state, or render parameters in the + <code>serveResource</code> call. + <p> + Only URLs of the type <code>FULL</code> are allowed in the response. + The same restriction is true for all downstream URLs that result from + this response call. Attempts to create URLs that are not of type + <code>FULL</code> will result in an <code>IllegalStateException</code>. + <p> + URLs of the type <code>FULL</code> have the highest cacheability in the + browser as they do not depend on any state of the portlet or page.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.portlet.ResourceURL.FULL">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PORTLET"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PORTLET</h4> +<pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> PORTLET</pre> +<div class="block">The URL of type <code>PORTLRET</code> does not need to contain the + current state of the page, but the current render parameters, portlet + mode, or window state of the portlet must be accessible to the portlet. + <p> + Only URLs of the type <code>PORTLET</code> or <code>FULL</code> are + allowed in the response. The same restriction + is true for all downstream URLs that result from this response. + Attempts to create URLs that are not of type + <code>PORTLET</code> or <code>FULL</code> will result in an + <code>IllegalStateException</code>. + <p> + URLs of the type <code>PORTLET</code> are cacheable on the portlet + level in the browser and can be served from the browser cache for as long + as the state of this portlet does not change.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.portlet.ResourceURL.PORTLET">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PAGE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PAGE</h4> +<pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> PAGE</pre> +<div class="block">The URL of type <code>PAGE</code> may contain artifacts that require + knowledge of the state of the complete page, like + <code>PortletURLs</code>. + <p> + URLs of the type <code>PAGE</code> are only cacheable on the page level + and can only be served from the browser cache as long as no state on the + page changes.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.portlet.ResourceURL.PAGE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="SHARED"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SHARED</h4> +<pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> SHARED</pre> +<div class="block">Property that the portlet can set for resources with caching + type <code>FULL</code> via the <code>setProperty</code> method + on the <code>ResourceURL</code>. + <p> + When set, this property indicates to the portal application + that it can share this resource across different portlet applications. + <p> + The value of this property should be a QName in the + format of <code>javax.xml.namespace.QName.toString()</code>.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.portlet.ResourceURL.SHARED">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setResourceID(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setResourceID</h4> +<pre>void setResourceID(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> resourceID)</pre> +<div class="block">Allows setting a resource ID that can be retrieved when serving the + resource through the <a href="../../javax/portlet/ResourceRequest.html#getResourceID()"><code>ResourceRequest.getResourceID()</code></a> method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>resourceID</code> - ID for this resource URL</dd></dl> +</li> +</ul> +<a name="getCacheability()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCacheability</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getCacheability()</pre> +<div class="block">Returns the cache level of this resource URL. + <p> + Possible return values are: <code>FULL, PORTLET</code> + or <code>PAGE</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the cache level of this resource URL.</dd></dl> +</li> +</ul> +<a name="setCacheability(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setCacheability</h4> +<pre>void setCacheability(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> cacheLevel)</pre> +<div class="block">Sets the cache level of this resource URL. + <p> + Possible values are: <code>FULL, PORTLET</code> + or <code>PAGE</code>. + <p> + Note that if this URL is created inside a + <code>serveResource</code> call it must have + at minimum the same cacheablity, or a more + restrictive one, as the parent resource URL, + otherwise an IllegalStateException is thrown. + <p> + The default cache level of a resource URL is either the cache level of the + parent resource URL, or <code>PAGE</code> if no parent resource URL is + available.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cacheLevel</code> - the cache level of this resource URL.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code> - if this resource URL has a weaker cache level + than the parent resource URL.</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if the cacheLevel is unknown to the portlet container</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ResourceURL.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../index-all.html">Index</a></li> +<li><a href="../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../javax/portlet/ResourceServingPortlet.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/ResourceURL.html" target="_top">Frames</a></li> +<li><a href="ResourceURL.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/StateAwareResponse.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/StateAwareResponse.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/StateAwareResponse.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/StateAwareResponse.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,553 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Thu Jul 16 17:20:27 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StateAwareResponse (Java Portlet Specification V2.1.0 1.0 API)</title> +<meta name="date" content="2015-07-16"> +<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="StateAwareResponse (Java Portlet Specification V2.1.0 1.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/StateAwareResponse.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../index-all.html">Index</a></li> +<li><a href="../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../javax/portlet/ResourceURL.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/UnavailableException.html" title="class in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/StateAwareResponse.html" target="_top">Frames</a></li> +<li><a href="StateAwareResponse.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">javax.portlet</div> +<h2 title="Interface StateAwareResponse" class="title">Interface StateAwareResponse</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<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>All Known Implementing Classes:</dt> +<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> +<br> +<pre>public interface <span class="strong">StateAwareResponse</span> +extends <a href="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></pre> +<div class="block">The <CODE>StateAwareResponse</CODE> represents a response that can modify + state information or send events.<BR> + It extends the PortletResponse interface.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet"><code>PortletResponse</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/StateAwareResponse.html#getPortletMode()">getPortletMode</a></strong>()</code> +<div class="block">Returns the currently set portlet mode on this reponse.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/StateAwareResponse.html#getRenderParameterMap()">getRenderParameterMap</a></strong>()</code> +<div class="block">Returns a <code>Map</code> of the render parameters currently set on + this response.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a></code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/StateAwareResponse.html#getWindowState()">getWindowState</a></strong>()</code> +<div class="block">Returns the currently set window state on this response.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/StateAwareResponse.html#removePublicRenderParameter(java.lang.String)">removePublicRenderParameter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Removes the specified public render parameter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/StateAwareResponse.html#setEvent(javax.xml.namespace.QName,%20java.io.Serializable)">setEvent</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true"; title="class or interface in javax.xml.namespace">QName</a> name, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a> value)</code> +<div class="block">Publishes an Event with the given payload.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/StateAwareResponse.html#setEvent(java.lang.String,%20java.io.Serializable)">setEvent</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a> value)</code> +<div class="block">Publishes an Event with the given payload in the default namespace.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/StateAwareResponse.html#setPortletMode(javax.portlet.PortletMode)">setPortletMode</a></strong>(<a href="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a> portletMode)</code> +<div class="block">Sets the portlet mode of a portlet to the given portlet mode.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/StateAwareResponse.html#setRenderParameter(java.lang.String,%20java.lang.String)">setRenderParameter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> value)</code> +<div class="block">Sets a String parameter for the render request.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/StateAwareResponse.html#setRenderParameter(java.lang.String,%20java.lang.String[])">setRenderParameter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] values)</code> +<div class="block">Sets a String array parameter for the render request.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/StateAwareResponse.html#setRenderParameters(java.util.Map)">setRenderParameters</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]> parameters)</code> +<div class="block">Sets a parameter map for the render request.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/StateAwareResponse.html#setWindowState(javax.portlet.WindowState)">setWindowState</a></strong>(<a href="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> windowState)</code> +<div class="block">Sets the window state of a portlet to the given window state.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_javax.portlet.PortletResponse"> +<!-- --> +</a> +<h3>Methods inherited from interface javax.portlet.<a href="../../javax/portlet/PortletResponse.html" title="interface in javax.portlet">PortletResponse</a></h3> +<code><a href="../../javax/portlet/PortletResponse.html#addProperty(javax.servlet.http.Cookie)">addProperty</a>, <a href="../../javax/portlet/PortletResponse.html#addProperty(java.lang.String,%20org.w3c.dom.Element)">addProperty</a>, <a href="../../javax/portlet/PortletResponse.html#addProperty(java.lang.String,%20java.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,%20java.lang.String)">setProperty</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setWindowState(javax.portlet.WindowState)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setWindowState</h4> +<pre>void setWindowState(<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> +<div class="block">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></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>windowState</code> - the new portlet window state</dd> +<dt><span class="strong">Throws:</span></dt> +<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> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code> - if the method is invoked after <code>sendRedirect</code> + has been called.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/portlet/WindowState.html" title="class in javax.portlet"><code>WindowState</code></a></dd></dl> +</li> +</ul> +<a name="setPortletMode(javax.portlet.PortletMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPortletMode</h4> +<pre>void setPortletMode(<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> +<div class="block">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.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>portletMode</code> - the new portlet mode</dd> +<dt><span class="strong">Throws:</span></dt> +<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> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code> - if the method is invoked after <code>sendRedirect</code> + has been called.</dd></dl> +</li> +</ul> +<a name="setRenderParameters(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRenderParameters</h4> +<pre>void setRenderParameters(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]> parameters)</pre> +<div class="block">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.</div> +<dl><dt><span class="strong">Parameters:</span></dt><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>).</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></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> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code> - if the method is invoked after <code>sendRedirect</code> + has been called.</dd></dl> +</li> +</ul> +<a name="setRenderParameter(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRenderParameter</h4> +<pre>void setRenderParameter(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> value)</pre> +<div class="block">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.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - key of the render parameter</dd><dd><code>value</code> - value of the render parameter</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if key is <code>null</code>.</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code> - if the method is invoked after <code>sendRedirect</code> + has been called.</dd></dl> +</li> +</ul> +<a name="setRenderParameter(java.lang.String, java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRenderParameter</h4> +<pre>void setRenderParameter(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] values)</pre> +<div class="block">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.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - key of the render parameter</dd><dd><code>values</code> - values of the render parameter</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if key or value are <code>null</code>.</dd> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code> - if the method is invoked after <code>sendRedirect</code> + has been called.</dd></dl> +</li> +</ul> +<a name="setEvent(javax.xml.namespace.QName, java.io.Serializable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEvent</h4> +<pre>void setEvent(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true"; title="class or interface in javax.xml.namespace">QName</a> name, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a> value)</pre> +<div class="block">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.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the event name to publish, must not be <code>null</code></dd><dd><code>value</code> - the value of this event, must have a valid JAXB binding and + be serializable, or <code>null</code>.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></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.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="setEvent(java.lang.String, java.io.Serializable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEvent</h4> +<pre>void setEvent(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a> value)</pre> +<div class="block">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.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the local part of the event name to publish, must not be <code>null</code></dd><dd><code>value</code> - the value of this event, must have a valid JAXB binding and + be serializable, or <code>null</code>.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></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.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="getRenderParameterMap()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRenderParameterMap</h4> +<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[]> getRenderParameterMap()</pre> +<div class="block">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>.</div> +<dl><dt><span class="strong">Returns:</span></dt><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>).</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="getPortletMode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPortletMode</h4> +<pre><a href="../../javax/portlet/PortletMode.html" title="class in javax.portlet">PortletMode</a> getPortletMode()</pre> +<div class="block">Returns the currently set portlet mode on this reponse.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the portlet mode, or <code>null</code> if none is set</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="getWindowState()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWindowState</h4> +<pre><a href="../../javax/portlet/WindowState.html" title="class in javax.portlet">WindowState</a> getWindowState()</pre> +<div class="block">Returns the currently set window state on this response.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the window state, or <code>null</code> if none is set</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="removePublicRenderParameter(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>removePublicRenderParameter</h4> +<pre>void removePublicRenderParameter(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">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.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> specifying + the name of the public render parameter to be removed</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if name is <code>null</code>.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/StateAwareResponse.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../index-all.html">Index</a></li> +<li><a href="../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../javax/portlet/ResourceURL.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/UnavailableException.html" title="class in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/StateAwareResponse.html" target="_top">Frames</a></li> +<li><a href="StateAwareResponse.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Added: portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/UnavailableException.html URL: http://svn.apache.org/viewvc/portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/UnavailableException.html?rev=1691468&view=auto ============================================================================== --- portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/UnavailableException.html (added) +++ portals/site-live/portlet-api/portlet-api-2.1.0/javax/portlet/UnavailableException.html Fri Jul 17 00:43:22 2015 @@ -0,0 +1,371 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Thu Jul 16 17:20:27 PDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>UnavailableException (Java Portlet Specification V2.1.0 1.0 API)</title> +<meta name="date" content="2015-07-16"> +<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="UnavailableException (Java Portlet Specification V2.1.0 1.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/UnavailableException.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../index-all.html">Index</a></li> +<li><a href="../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/ValidatorException.html" title="class in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/UnavailableException.html" target="_top">Frames</a></li> +<li><a href="UnavailableException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">javax.portlet</div> +<h2 title="Class UnavailableException" class="title">Class UnavailableException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">java.lang.Throwable</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">java.lang.Exception</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">javax.portlet.PortletException</a></li> +<li> +<ul class="inheritance"> +<li>javax.portlet.UnavailableException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">UnavailableException</span> +extends <a href="../../javax/portlet/PortletException.html" title="class in javax.portlet">PortletException</a></pre> +<div class="block">The portlet should throw the <CODE>UnavailableException</CODE> when + the portlet is either temporarily or permanently unavailable to handle requests.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../serialized-form.html#javax.portlet.UnavailableException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../javax/portlet/UnavailableException.html#UnavailableException(java.lang.String)">UnavailableException</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> text)</code> +<div class="block">Constructs a new exception with a descriptive + message indicating that the portlet is permanently + unavailable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../javax/portlet/UnavailableException.html#UnavailableException(java.lang.String,%20int)">UnavailableException</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> text, + int seconds)</code> +<div class="block">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.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/UnavailableException.html#getUnavailableSeconds()">getUnavailableSeconds</a></strong>()</code> +<div class="block">Returns the time in seconds for which the portlet can be expected to + be unavailable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../javax/portlet/UnavailableException.html#isPermanent()">isPermanent</a></strong>()</code> +<div class="block">Returns a <code>boolean</code> indicating + whether the portlet is permanently unavailable.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></h3> +<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed(java.lang.Throwable)" title="class or interface in java.lang">addSuppressed</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace()" title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#getCause()" title="class or interface in java.lang">getCause</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage()" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#getMessage()" title="class or interface in java.lang">getMessage</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace( )" title="class or interface in java.lang">getStackTrace</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed()" title="class or interface in java.lang">getSuppressed</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#initCause(java.lang.Throwable)" title="class or interface in java.lang">initCause</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace()" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace(java.io.PrintStream)" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace(java.io.PrintWriter)" title="class or interface in java.lang">printStackTrace</a>, <a href="http: //docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace(java.lang.StackTraceElement[])" title="class or interface in java.lang">setStackTrace</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/jav ase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="UnavailableException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UnavailableException</h4> +<pre>public UnavailableException(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> text)</pre> +<div class="block">Constructs a new exception with a descriptive + message indicating that the portlet is permanently + unavailable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - a <code>String</code> specifying the + descriptive message</dd></dl> +</li> +</ul> +<a name="UnavailableException(java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UnavailableException</h4> +<pre>public UnavailableException(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> text, + int seconds)</pre> +<div class="block">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.</div> +<dl><dt><span class="strong">Parameters:</span></dt><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><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.</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isPermanent()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPermanent</h4> +<pre>public boolean isPermanent()</pre> +<div class="block">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.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the portlet is + permanently unavailable; <code>false</code> + if the portlet is temporarily + unavailable.</dd></dl> +</li> +</ul> +<a name="getUnavailableSeconds()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getUnavailableSeconds</h4> +<pre>public int getUnavailableSeconds()</pre> +<div class="block">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.</div> +<dl><dt><span class="strong">Returns:</span></dt><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.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/UnavailableException.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../index-all.html">Index</a></li> +<li><a href="../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../javax/portlet/StateAwareResponse.html" title="interface in javax.portlet"><span class="strong">Prev Class</span></a></li> +<li><a href="../../javax/portlet/ValidatorException.html" title="class in javax.portlet"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?javax/portlet/UnavailableException.html" target="_top">Frames</a></li> +<li><a href="UnavailableException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2004–2015 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
