blob: 65f0cf953f2fc9cc222da347ac41fde94282c951 [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>MetadataReference (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="MetadataReference (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/MetadataReference.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/mex/om/Metadata.html" title="class in org.apache.axis2.mex.om"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/axis2/mex/om/MetadataSection.html" title="class in org.apache.axis2.mex.om"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/axis2/mex/om/MetadataReference.html" target="_top">Frames</a></li>
<li><a href="MetadataReference.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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.mex.om</div>
<h2 title="Class MetadataReference" class="title">Class MetadataReference</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/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="../../../../../org/apache/axis2/mex/om/MexOM.html" title="class in org.apache.axis2.mex.om">org.apache.axis2.mex.om.MexOM</a></li>
<li>
<ul class="inheritance">
<li>org.apache.axis2.mex.om.MetadataReference</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/axis2/mex/om/IMexOM.html" title="interface in org.apache.axis2.mex.om">IMexOM</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">MetadataReference</span>
extends <a href="../../../../../org/apache/axis2/mex/om/MexOM.html" title="class in org.apache.axis2.mex.om">MexOM</a>
implements <a href="../../../../../org/apache/axis2/mex/om/IMexOM.html" title="interface in org.apache.axis2.mex.om">IMexOM</a></pre>
<div class="block">Class implemented for MetadataReference element defined in
the WS-MetadataExchange spec.</div>
</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">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/axis2/mex/om/MetadataReference.html#MetadataReference()">MetadataReference</a></strong>()</code>
<div class="block">Constructor</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/axis2/mex/om/MetadataReference.html#MetadataReference(org.apache.axiom.om.OMFactory, java.lang.String)">MetadataReference</a></strong>(<a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMFactory.html?is-external=true" title="class or interface in org.apache.axiom.om">OMFactory</a>&nbsp;defaultFactory,
<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;namespaceValue)</code>
<div class="block">Constructor</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">&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><a href="../../../../../org/apache/axis2/mex/om/MetadataReference.html" title="class in org.apache.axis2.mex.om">MetadataReference</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/mex/om/MetadataReference.html#fromOM(org.apache.axiom.om.OMElement)">fromOM</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;element)</code>
<div class="block">Populates an MetadataReference object based on the endpoint reference type <code>OMElement</code> passed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/axis2/addressing/EndpointReference.html" title="class in org.apache.axis2.addressing">EndpointReference</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/mex/om/MetadataReference.html#getEPR()">getEPR</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/mex/om/MetadataReference.html#getEPRElement()">getEPRElement</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/mex/om/MetadataReference.html#setEPR(org.apache.axis2.addressing.EndpointReference)">setEPR</a></strong>(<a href="../../../../../org/apache/axis2/addressing/EndpointReference.html" title="class in org.apache.axis2.addressing">EndpointReference</a>&nbsp;endRef)</code>
<div class="block">Set EPR</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/mex/om/MetadataReference.html#setEPR(org.apache.axiom.om.OMElement)">setEPR</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;element)</code>
<div class="block">Set EPR</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/mex/om/MetadataReference.html#toOM()">toOM</a></strong>()</code>
<div class="block">Convert MetadatReference object content to the OMElement representation.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.axis2.mex.om.MexOM">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.axis2.mex.om.<a href="../../../../../org/apache/axis2/mex/om/MexOM.html" title="class in org.apache.axis2.mex.om">MexOM</a></h3>
<code><a href="../../../../../org/apache/axis2/mex/om/MexOM.html#getNamespaceValue()">getNamespaceValue</a>, <a href="../../../../../org/apache/axis2/mex/om/MexOM.html#isNamespaceSupported(java.lang.String)">isNamespaceSupported</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&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.axis2.mex.om.IMexOM">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.axis2.mex.om.<a href="../../../../../org/apache/axis2/mex/om/IMexOM.html" title="interface in org.apache.axis2.mex.om">IMexOM</a></h3>
<code><a href="../../../../../org/apache/axis2/mex/om/IMexOM.html#getNamespaceValue()">getNamespaceValue</a>, <a href="../../../../../org/apache/axis2/mex/om/IMexOM.html#isNamespaceSupported(java.lang.String)">isNamespaceSupported</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="MetadataReference()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MetadataReference</h4>
<pre>public&nbsp;MetadataReference()
throws <a href="../../../../../org/apache/axis2/mex/MexException.html" title="class in org.apache.axis2.mex">MexException</a></pre>
<div class="block">Constructor</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/axis2/mex/MexException.html" title="class in org.apache.axis2.mex">MexException</a></code></dd></dl>
</li>
</ul>
<a name="MetadataReference(org.apache.axiom.om.OMFactory, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MetadataReference</h4>
<pre>public&nbsp;MetadataReference(<a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMFactory.html?is-external=true" title="class or interface in org.apache.axiom.om">OMFactory</a>&nbsp;defaultFactory,
<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;namespaceValue)
throws <a href="../../../../../org/apache/axis2/mex/om/MexOMException.html" title="class in org.apache.axis2.mex.om">MexOMException</a></pre>
<div class="block">Constructor</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultFactory</code> - </dd><dd><code>namespaceValue</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/axis2/mex/om/MexOMException.html" title="class in org.apache.axis2.mex.om">MexOMException</a></code></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="getEPRElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEPRElement</h4>
<pre>public&nbsp;<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;getEPRElement()</pre>
</li>
</ul>
<a name="getEPR()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEPR</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/axis2/addressing/EndpointReference.html" title="class in org.apache.axis2.addressing">EndpointReference</a>&nbsp;getEPR()</pre>
</li>
</ul>
<a name="fromOM(org.apache.axiom.om.OMElement)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromOM</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/axis2/mex/om/MetadataReference.html" title="class in org.apache.axis2.mex.om">MetadataReference</a>&nbsp;fromOM(<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;element)
throws <a href="../../../../../org/apache/axis2/mex/om/MexOMException.html" title="class in org.apache.axis2.mex.om">MexOMException</a></pre>
<div class="block">Populates an MetadataReference object based on the endpoint reference type <code>OMElement</code> passed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>inElement</code> - MetadataReference element</dd>
<dt><span class="strong">Returns:</span></dt><dd>MetadataReference</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/axis2/mex/om/MexOMException.html" title="class in org.apache.axis2.mex.om">MexOMException</a></code></dd></dl>
</li>
</ul>
<a name="toOM()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toOM</h4>
<pre>public&nbsp;<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;toOM()
throws <a href="../../../../../org/apache/axis2/mex/om/MexOMException.html" title="class in org.apache.axis2.mex.om">MexOMException</a></pre>
<div class="block">Convert MetadatReference object content to the OMElement representation.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/axis2/mex/om/IMexOM.html#toOM()">toOM</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/axis2/mex/om/IMexOM.html" title="interface in org.apache.axis2.mex.om">IMexOM</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/axis2/mex/om/MexOM.html#toOM()">toOM</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/axis2/mex/om/MexOM.html" title="class in org.apache.axis2.mex.om">MexOM</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>OMElement representation of MetadatReference.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/axis2/mex/om/MexOMException.html" title="class in org.apache.axis2.mex.om">MexOMException</a></code></dd></dl>
</li>
</ul>
<a name="setEPR(org.apache.axiom.om.OMElement)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEPR</h4>
<pre>public&nbsp;void&nbsp;setEPR(<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;element)
throws <a href="../../../../../org/apache/axis2/mex/om/MexOMException.html" title="class in org.apache.axis2.mex.om">MexOMException</a></pre>
<div class="block">Set EPR</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - Endpoint Reference Type element</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/axis2/mex/om/MexOMException.html" title="class in org.apache.axis2.mex.om">MexOMException</a></code></dd></dl>
</li>
</ul>
<a name="setEPR(org.apache.axis2.addressing.EndpointReference)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setEPR</h4>
<pre>public&nbsp;void&nbsp;setEPR(<a href="../../../../../org/apache/axis2/addressing/EndpointReference.html" title="class in org.apache.axis2.addressing">EndpointReference</a>&nbsp;endRef)
throws <a href="../../../../../org/apache/axis2/mex/om/MexOMException.html" title="class in org.apache.axis2.mex.om">MexOMException</a></pre>
<div class="block">Set EPR</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - Endpoint Reference Type elem</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/axis2/mex/om/MexOMException.html" title="class in org.apache.axis2.mex.om">MexOMException</a></code></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/MetadataReference.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/mex/om/Metadata.html" title="class in org.apache.axis2.mex.om"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/axis2/mex/om/MetadataSection.html" title="class in org.apache.axis2.mex.om"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/axis2/mex/om/MetadataReference.html" target="_top">Frames</a></li>
<li><a href="MetadataReference.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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>