blob: 00e1816e83c787a5a69b78a974c31fdd92baa93e [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ParameterInclude (Apache Axis2)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ParameterInclude (Apache Axis2)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.axis2.description</a></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><code><a href="../engine/AxisObserver.html" title="interface in org.apache.axis2.engine">AxisObserver</a></code>, <code><a href="../clustering/ClusteringAgent.html" title="interface in org.apache.axis2.clustering">ClusteringAgent</a></code>, <code><a href="../clustering/management/NodeManager.html" title="interface in org.apache.axis2.clustering.management">NodeManager</a></code>, <code><a href="../clustering/state/StateManager.html" title="interface in org.apache.axis2.clustering.state">StateManager</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="AxisBinding.html" title="class in org.apache.axis2.description">AxisBinding</a></code>, <code><a href="AxisBindingMessage.html" title="class in org.apache.axis2.description">AxisBindingMessage</a></code>, <code><a href="AxisBindingOperation.html" title="class in org.apache.axis2.description">AxisBindingOperation</a></code>, <code><a href="../engine/AxisConfiguration.html" title="class in org.apache.axis2.engine">AxisConfiguration</a></code>, <code><a href="AxisDescription.html" title="class in org.apache.axis2.description">AxisDescription</a></code>, <code><a href="AxisEndpoint.html" title="class in org.apache.axis2.description">AxisEndpoint</a></code>, <code><a href="AxisMessage.html" title="class in org.apache.axis2.description">AxisMessage</a></code>, <code><a href="AxisModule.html" title="class in org.apache.axis2.description">AxisModule</a></code>, <code><a href="AxisOperation.html" title="class in org.apache.axis2.description">AxisOperation</a></code>, <code><a href="AxisService.html" title="class in org.apache.axis2.description">AxisService</a></code>, <code><a href="AxisServiceGroup.html" title="class in org.apache.axis2.description">AxisServiceGroup</a></code>, <code><a href="../clustering/management/DefaultNodeManager.html" title="class in org.apache.axis2.clustering.management">DefaultNodeManager</a></code>, <code><a href="../clustering/state/DefaultStateManager.html" title="class in org.apache.axis2.clustering.state">DefaultStateManager</a></code>, <code><a href="HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a></code>, <code><a href="InOnlyAxisOperation.html" title="class in org.apache.axis2.description">InOnlyAxisOperation</a></code>, <code><a href="InOutAxisOperation.html" title="class in org.apache.axis2.description">InOutAxisOperation</a></code>, <code><a href="ModuleConfiguration.html" title="class in org.apache.axis2.description">ModuleConfiguration</a></code>, <code><a href="OutInAxisOperation.html" title="class in org.apache.axis2.description">OutInAxisOperation</a></code>, <code><a href="OutOnlyAxisOperation.html" title="class in org.apache.axis2.description">OutOnlyAxisOperation</a></code>, <code><a href="ParameterIncludeImpl.html" title="class in org.apache.axis2.description">ParameterIncludeImpl</a></code>, <code><a href="RobustOutOnlyAxisOperation.html" title="class in org.apache.axis2.description">RobustOutOnlyAxisOperation</a></code>, <code><a href="TransportInDescription.html" title="class in org.apache.axis2.description">TransportInDescription</a></code>, <code><a href="TransportOutDescription.html" title="class in org.apache.axis2.description">TransportOutDescription</a></code>, <code><a href="../clustering/tribes/TribesAxisObserver.html" title="class in org.apache.axis2.clustering.tribes">TribesAxisObserver</a></code>, <code><a href="../clustering/tribes/TribesClusteringAgent.html" title="class in org.apache.axis2.clustering.tribes">TribesClusteringAgent</a></code>, <code><a href="TwoChannelAxisOperation.html" title="class in org.apache.axis2.description">TwoChannelAxisOperation</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">ParameterInclude</span></pre>
<div class="block">Interface ParameterInclude</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addParameter(org.apache.axis2.description.Parameter)">addParameter</a></span>&#8203;(<a href="Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;param)</code></th>
<td class="colLast">
<div class="block">Method addParameter.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deserializeParameters(org.apache.axiom.om.OMElement)">deserializeParameters</a></span>&#8203;(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a>&nbsp;parameterElement)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="Parameter.html" title="class in org.apache.axis2.description">Parameter</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameter(java.lang.String)">getParameter</a></span>&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Method getParameter.</div>
</td>
</tr>
<tr id="i3" 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" class="externalLink">ArrayList</a>&lt;<a href="Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameters()">getParameters</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets all the parameters in a given description.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isParameterLocked(java.lang.String)">isParameterLocked</a></span>&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;parameterName)</code></th>
<td class="colLast">
<div class="block">Checks whether the parameter is locked at any level.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeParameter(org.apache.axis2.description.Parameter)">removeParameter</a></span>&#8203;(<a href="Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;param)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="addParameter(org.apache.axis2.description.Parameter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addParameter</h4>
<pre class="methodSignature">void&nbsp;addParameter&#8203;(<a href="Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;param)
throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block">Method addParameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>param</code> - </dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd>
</dl>
</li>
</ul>
<a id="removeParameter(org.apache.axis2.description.Parameter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeParameter</h4>
<pre class="methodSignature">void&nbsp;removeParameter&#8203;(<a href="Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;param)
throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd>
</dl>
</li>
</ul>
<a id="deserializeParameters(org.apache.axiom.om.OMElement)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeParameters</h4>
<pre class="methodSignature">void&nbsp;deserializeParameters&#8203;(<a href="https://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMElement.html?is-external=true" title="class or interface in org.apache.axiom.om" class="externalLink">OMElement</a>&nbsp;parameterElement)
throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd>
</dl>
</li>
</ul>
<a id="getParameter(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameter</h4>
<pre class="methodSignature"><a href="Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;getParameter&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</pre>
<div class="block">Method getParameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns Parameter.</dd>
</dl>
</li>
</ul>
<a id="getParameters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameters</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/7/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util" class="externalLink">ArrayList</a>&lt;<a href="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="returnLabel">Returns:</span></dt>
<dd>Returns ArrayList.</dd>
</dl>
</li>
</ul>
<a id="isParameterLocked(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isParameterLocked</h4>
<pre class="methodSignature">boolean&nbsp;isParameterLocked&#8203;(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;parameterName)</pre>
<div class="block">Checks whether the parameter is locked at any level.</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</footer>
</body>
</html>