blob: 4f5964c222ddf7e0bd1d5bb0e6dc34d0725289c3 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>ParameterInclude (Apache Axis2)</title>
<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="ParameterInclude (Apache Axis2)";
}
//-->
</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/ParameterInclude.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="../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/axis2/description/ParameterIncludeImpl.html" title="class in org.apache.axis2.description"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis2/description/ParameterInclude.html" target="_top">Frames</a></li>
<li><a href="ParameterInclude.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">org.apache.axis2.description</div>
<h2 title="Interface ParameterInclude" class="title">Interface ParameterInclude</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/apache/axis2/engine/AxisObserver.html" title="interface in org.apache.axis2.engine">AxisObserver</a>, <a href="../../../../org/apache/axis2/clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a>, <a href="../../../../org/apache/axis2/clustering/management/NodeManager.html" title="interface in org.apache.axis2.clustering.management">NodeManager</a>, <a href="../../../../org/apache/axis2/clustering/state/StateManager.html" title="interface in org.apache.axis2.clustering.state">StateManager</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/axis2/description/AxisBinding.html" title="class in org.apache.axis2.description">AxisBinding</a>, <a href="../../../../org/apache/axis2/description/AxisBindingMessage.html" title="class in org.apache.axis2.description">AxisBindingMessage</a>, <a href="../../../../org/apache/axis2/description/AxisBindingOperation.html" title="class in org.apache.axis2.description">AxisBindingOperation</a>, <a href="../../../../org/apache/axis2/engine/AxisConfiguration.html" title="class in org.apache.axis2.engine">AxisConfiguration</a>, <a href="../../../../org/apache/axis2/description/AxisDescription.html" title="class in org.apache.axis2.description">AxisDescription</a>, <a href="../../../../org/apache/axis2/description/AxisEndpoint.html" title="class in org.apache.axis2.description">AxisEndpoint</a>, <a href="../../../../org/apache/axis2/description/AxisMessage.html" title="class in org.apache.axis2.description">AxisMessage</a>, <a href="../../../../org/apache/axis2/description/AxisModule.html" title="class in org.apache.axis2.description">AxisModule</a>, <a href="../../../../org/apache/axis2/description/AxisOperation.html" title="class in org.apache.axis2.description">AxisOperation</a>, <a href="../../../../org/apache/axis2/description/AxisService.html" title="class in org.apache.axis2.description">AxisService</a>, <a href="../../../../org/apache/axis2/description/AxisServiceGroup.html" title="class in org.apache.axis2.description">AxisServiceGroup</a>, <a href="../../../../org/apache/axis2/clustering/management/DefaultNodeManager.html" title="class in org.apache.axis2.clustering.management">DefaultNodeManager</a>, <a href="../../../../org/apache/axis2/clustering/state/DefaultStateManager.html" title="class in org.apache.axis2.clustering.state">DefaultStateManager</a>, <a href="../../../../org/apache/axis2/description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a>, <a href="../../../../org/apache/axis2/description/InOnlyAxisOperation.html" title="class in org.apache.axis2.description">InOnlyAxisOperation</a>, <a href="../../../../org/apache/axis2/description/InOutAxisOperation.html" title="class in org.apache.axis2.description">InOutAxisOperation</a>, <a href="../../../../org/apache/axis2/description/ModuleConfiguration.html" title="class in org.apache.axis2.description">ModuleConfiguration</a>, <a href="../../../../org/apache/axis2/description/OutInAxisOperation.html" title="class in org.apache.axis2.description">OutInAxisOperation</a>, <a href="../../../../org/apache/axis2/description/OutOnlyAxisOperation.html" title="class in org.apache.axis2.description">OutOnlyAxisOperation</a>, <a href="../../../../org/apache/axis2/description/ParameterIncludeImpl.html" title="class in org.apache.axis2.description">ParameterIncludeImpl</a>, <a href="../../../../org/apache/axis2/description/RobustOutOnlyAxisOperation.html" title="class in org.apache.axis2.description">RobustOutOnlyAxisOperation</a>, <a href="../../../../org/apache/axis2/description/TransportInDescription.html" title="class in org.apache.axis2.description">TransportInDescription</a>, <a href="../../../../org/apache/axis2/description/TransportOutDescription.html" title="class in org.apache.axis2.description">TransportOutDescription</a>, <a href="../../../../org/apache/axis2/clustering/tribes/TribesAxisObserver.html" title="class in org.apache.axis2.clustering.tribes">TribesAxisObserver</a>, <a href="../../../../org/apache/axis2/clustering/tribes/TribesClusteringAgent.html" title="class in org.apache.axis2.clustering.tribes">TribesClusteringAgent</a>, <a href="../../../../org/apache/axis2/description/TwoChannelAxisOperation.html" title="class in org.apache.axis2.description">TwoChannelAxisOperation</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ParameterInclude</span></pre>
<div class="block">Interface ParameterInclude</div>
</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">&nbsp;</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/description/ParameterInclude.html#addParameter(org.apache.axis2.description.Parameter)">addParameter</a></strong>(<a href="../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;param)</code>
<div class="block">Method addParameter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/description/ParameterInclude.html#deserializeParameters(org.apache.axiom.om.OMElement)">deserializeParameters</a></strong>(<a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om">OMElement</a>&nbsp;parameterElement)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/description/ParameterInclude.html#getParameter(java.lang.String)">getParameter</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Method getParameter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a>&lt;<a href="../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/description/ParameterInclude.html#getParameters()">getParameters</a></strong>()</code>
<div class="block">Gets all the parameters in a given description.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/description/ParameterInclude.html#isParameterLocked(java.lang.String)">isParameterLocked</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;parameterName)</code>
<div class="block">Checks whether the parameter is locked at any level.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/description/ParameterInclude.html#removeParameter(org.apache.axis2.description.Parameter)">removeParameter</a></strong>(<a href="../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;param)</code>&nbsp;</td>
</tr>
</table>
</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="addParameter(org.apache.axis2.description.Parameter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addParameter</h4>
<pre>void&nbsp;addParameter(<a href="../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;param)
throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block">Method addParameter.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>param</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd></dl>
</li>
</ul>
<a name="removeParameter(org.apache.axis2.description.Parameter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeParameter</h4>
<pre>void&nbsp;removeParameter(<a href="../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;param)
throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd></dl>
</li>
</ul>
<a name="deserializeParameters(org.apache.axiom.om.OMElement)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeParameters</h4>
<pre>void&nbsp;deserializeParameters(<a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om">OMElement</a>&nbsp;parameterElement)
throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd></dl>
</li>
</ul>
<a name="getParameter(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameter</h4>
<pre><a href="../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;getParameter(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Method getParameter.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns Parameter.</dd></dl>
</li>
</ul>
<a name="getParameters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameters</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a>&lt;<a href="../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&gt;&nbsp;getParameters()</pre>
<div class="block">Gets all the parameters in a given description.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Returns ArrayList.</dd></dl>
</li>
</ul>
<a name="isParameterLocked(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isParameterLocked</h4>
<pre>boolean&nbsp;isParameterLocked(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;parameterName)</pre>
<div class="block">Checks whether the parameter is locked at any level.</div>
</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/ParameterInclude.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="../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/axis2/description/ParameterIncludeImpl.html" title="class in org.apache.axis2.description"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis2/description/ParameterInclude.html" target="_top">Frames</a></li>
<li><a href="ParameterInclude.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>