blob: 88cc561c84be21d16f04d60c3918501e9ad04977 [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>
<title>Detail</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Detail";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="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/xml/soap/AttachmentPart.html" title="class in javax.xml.soap"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/xml/soap/DetailEntry.html" title="interface in javax.xml.soap"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/xml/soap/Detail.html" target="_top">Frames</a></li>
<li><a href="Detail.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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">javax.xml.soap</div>
<h2 title="Interface Detail" class="title">Interface Detail</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>org.w3c.dom.Element, org.w3c.dom.Node, <a href="../../../javax/xml/soap/SOAPElement.html" title="interface in javax.xml.soap">SOAPElement</a>, <a href="../../../javax/xml/soap/SOAPFaultElement.html" title="interface in javax.xml.soap">SOAPFaultElement</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Detail</span>
extends <a href="../../../javax/xml/soap/SOAPFaultElement.html" title="interface in javax.xml.soap">SOAPFaultElement</a></pre>
<div class="block">A container for <code>DetailEntry</code> objects. <code>DetailEntry</code>
objects give detailed error information that is application-specific and
related to the <code>SOAPBody</code> object that contains it.
<P>
A <code>Detail</code> object, which is part of a <code>SOAPFault</code>
object, can be retrieved using the method <code>SOAPFault.getDetail</code>.
The <code>Detail</code> interface provides two methods. One creates a new
<code>DetailEntry</code> object and also automatically adds it to
the <code>Detail</code> object. The second method gets a list of the
<code>DetailEntry</code> objects contained in a <code>Detail</code>
object.
<P>
The following code fragment, in which <i>sf</i> is a <code>SOAPFault</code>
object, gets its <code>Detail</code> object (<i>d</i>), adds a new
<code>DetailEntry</code> object to <i>d</i>, and then gets a list of all the
<code>DetailEntry</code> objects in <i>d</i>. The code also creates a
<code>Name</code> object to pass to the method <code>addDetailEntry</code>.
The variable <i>se</i>, used to create the <code>Name</code> object,
is a <code>SOAPEnvelope</code> object.
<pre><code>
Detail d = sf.getDetail();
Name name = se.createName("GetLastTradePrice", "WOMBAT",
"http://www.wombat.org/trader");
d.addDetailEntry(name);
Iterator&lt;DetailEntry&gt; it = d.getDetailEntries();
</code></pre></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6</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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.w3c.dom.Node">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.w3c.dom.Node</h3>
<code>ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE</code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../javax/xml/soap/DetailEntry.html" title="interface in javax.xml.soap">DetailEntry</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/Detail.html#addDetailEntry-javax.xml.soap.Name-">addDetailEntry</a></span>(<a href="../../../javax/xml/soap/Name.html" title="interface in javax.xml.soap">Name</a>&nbsp;name)</code>
<div class="block">Creates a new <code>DetailEntry</code> object with the given
name and adds it to this <code>Detail</code> object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../javax/xml/soap/DetailEntry.html" title="interface in javax.xml.soap">DetailEntry</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/Detail.html#addDetailEntry-javax.xml.namespace.QName-">addDetailEntry</a></span>(javax.xml.namespace.QName&nbsp;qname)</code>
<div class="block">Creates a new <code>DetailEntry</code> object with the given
QName and adds it to this <code>Detail</code> object.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Iterator&lt;<a href="../../../javax/xml/soap/DetailEntry.html" title="interface in javax.xml.soap">DetailEntry</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/Detail.html#getDetailEntries--">getDetailEntries</a></span>()</code>
<div class="block">Gets an Iterator over all of the <code>DetailEntry</code>s in this <code>Detail</code> object.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.xml.soap.SOAPElement">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;javax.xml.soap.<a href="../../../javax/xml/soap/SOAPElement.html" title="interface in javax.xml.soap">SOAPElement</a></h3>
<code><a href="../../../javax/xml/soap/SOAPElement.html#addAttribute-javax.xml.soap.Name-java.lang.String-">addAttribute</a>, <a href="../../../javax/xml/soap/SOAPElement.html#addAttribute-javax.xml.namespace.QName-java.lang.String-">addAttribute</a>, <a href="../../../javax/xml/soap/SOAPElement.html#addChildElement-javax.xml.soap.Name-">addChildElement</a>, <a href="../../../javax/xml/soap/SOAPElement.html#addChildElement-javax.xml.namespace.QName-">addChildElement</a>, <a href="../../../javax/xml/soap/SOAPElement.html#addChildElement-javax.xml.soap.SOAPElement-">addChildElement</a>, <a href="../../../javax/xml/soap/SOAPElement.html#addChildElement-java.lang.String-">addChildElement</a>, <a href="../../../javax/xml/soap/SOAPElement.html#addChildElement-java.lang.String-java.lang.String-">addChildElement</a>, <a href="../../../javax/xml/soap/SOAPElement.html#addChildElement-java.lang.String-java.lang.String-java.lang.String-">addChildElement</a>, <a href="../../../javax/xml/soap/SOAPElement.html#addNamespaceDeclaration-java.lang.String-java.lang.String-">addNamespaceDeclaration</a>, <a href="../../../javax/xml/soap/SOAPElement.html#addTextNode-java.lang.String-">addTextNode</a>, <a href="../../../javax/xml/soap/SOAPElement.html#createQName-java.lang.String-java.lang.String-">createQName</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getAllAttributes--">getAllAttributes</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getAllAttributesAsQNames--">getAllAttributesAsQNames</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getAttributeValue-javax.xml.soap.Name-">getAttributeValue</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getAttributeValue-javax.xml.namespace.QName-">getAttributeValue</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getChildElements--">getChildElements</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getChildElements-javax.xml.soap.Name-">getChildElements</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getChildElements-javax.xml.namespace.QName-">getChildElements</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getElementName--">getElementName</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getElementQName--">getElementQName</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getEncodingStyle--">getEncodingStyle</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getNamespacePrefixes--">getNamespacePrefixes</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getNamespaceURI-java.lang.String-">getNamespaceURI</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getVisibleNamespacePrefixes--">getVisibleNamespacePrefixes</a>, <a href="../../../javax/xml/soap/SOAPElement.html#removeAttribute-javax.xml.soap.Name-">removeAttribute</a>, <a href="../../../javax/xml/soap/SOAPElement.html#removeAttribute-javax.xml.namespace.QName-">removeAttribute</a>, <a href="../../../javax/xml/soap/SOAPElement.html#removeContents--">removeContents</a>, <a href="../../../javax/xml/soap/SOAPElement.html#removeNamespaceDeclaration-java.lang.String-">removeNamespaceDeclaration</a>, <a href="../../../javax/xml/soap/SOAPElement.html#setElementQName-javax.xml.namespace.QName-">setElementQName</a>, <a href="../../../javax/xml/soap/SOAPElement.html#setEncodingStyle-java.lang.String-">setEncodingStyle</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.xml.soap.Node">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;javax.xml.soap.<a href="../../../javax/xml/soap/Node.html" title="interface in javax.xml.soap">Node</a></h3>
<code><a href="../../../javax/xml/soap/Node.html#detachNode--">detachNode</a>, <a href="../../../javax/xml/soap/Node.html#getParentElement--">getParentElement</a>, <a href="../../../javax/xml/soap/Node.html#getValue--">getValue</a>, <a href="../../../javax/xml/soap/Node.html#recycleNode--">recycleNode</a>, <a href="../../../javax/xml/soap/Node.html#setParentElement-javax.xml.soap.SOAPElement-">setParentElement</a>, <a href="../../../javax/xml/soap/Node.html#setValue-java.lang.String-">setValue</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.w3c.dom.Element">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.w3c.dom.Element</h3>
<code>getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.w3c.dom.Node">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.w3c.dom.Node</h3>
<code>appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData</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="addDetailEntry-javax.xml.soap.Name-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addDetailEntry</h4>
<pre><a href="../../../javax/xml/soap/DetailEntry.html" title="interface in javax.xml.soap">DetailEntry</a>&nbsp;addDetailEntry(<a href="../../../javax/xml/soap/Name.html" title="interface in javax.xml.soap">Name</a>&nbsp;name)
throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre>
<div class="block">Creates a new <code>DetailEntry</code> object with the given
name and adds it to this <code>Detail</code> object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - a <code>Name</code> object identifying the
new <code>DetailEntry</code> object</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new <code>DetailEntry</code> object that was
created</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - thrown when there is a problem in adding a
DetailEntry object to this Detail object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../javax/xml/soap/Detail.html#addDetailEntry-javax.xml.namespace.QName-"><code>addDetailEntry(QName qname)</code></a></dd>
</dl>
</li>
</ul>
<a name="addDetailEntry-javax.xml.namespace.QName-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addDetailEntry</h4>
<pre><a href="../../../javax/xml/soap/DetailEntry.html" title="interface in javax.xml.soap">DetailEntry</a>&nbsp;addDetailEntry(javax.xml.namespace.QName&nbsp;qname)
throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre>
<div class="block">Creates a new <code>DetailEntry</code> object with the given
QName and adds it to this <code>Detail</code> object. This method
is the preferred over the one using Name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>qname</code> - a <code>QName</code> object identifying the
new <code>DetailEntry</code> object</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new <code>DetailEntry</code> object that was
created</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - thrown when there is a problem in adding a
DetailEntry object to this Detail object.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6, SAAJ 1.3</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../javax/xml/soap/Detail.html#addDetailEntry-javax.xml.soap.Name-"><code>addDetailEntry(Name name)</code></a></dd>
</dl>
</li>
</ul>
<a name="getDetailEntries--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDetailEntries</h4>
<pre>java.util.Iterator&lt;<a href="../../../javax/xml/soap/DetailEntry.html" title="interface in javax.xml.soap">DetailEntry</a>&gt;&nbsp;getDetailEntries()</pre>
<div class="block">Gets an Iterator over all of the <code>DetailEntry</code>s in this <code>Detail</code> object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an <code>Iterator</code> object over the <code>DetailEntry</code>
objects in this <code>Detail</code> object</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="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/xml/soap/AttachmentPart.html" title="class in javax.xml.soap"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/xml/soap/DetailEntry.html" title="interface in javax.xml.soap"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/xml/soap/Detail.html" target="_top">Frames</a></li>
<li><a href="Detail.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.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>
</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 ======= -->
</body>
</html>