Package jakarta.xml.soap
Interface Detail
-
- All Superinterfaces:
Element
,Node
,Node
,SOAPElement
,SOAPFaultElement
public interface Detail extends SOAPFaultElement
A container forDetailEntry
objects.DetailEntry
objects give detailed error information that is application-specific and related to theSOAPBody
object that contains it.A
Detail
object, which is part of aSOAPFault
object, can be retrieved using the methodSOAPFault.getDetail
. TheDetail
interface provides two methods. One creates a newDetailEntry
object and also automatically adds it to theDetail
object. The second method gets a list of theDetailEntry
objects contained in aDetail
object.The following code fragment, in which sf is a
SOAPFault
object, gets itsDetail
object (d), adds a newDetailEntry
object to d, and then gets a list of all theDetailEntry
objects in d. The code also creates aName
object to pass to the methodaddDetailEntry
. The variable se, used to create theName
object, is aSOAPEnvelope
object.Detail d = sf.getDetail(); Name name = se.createName("GetLastTradePrice", "WOMBAT", "http://www.wombat.org/trader"); d.addDetailEntry(name); Iterator<DetailEntry> it = d.getDetailEntries();
- Since:
- 1.6
-
-
Field Summary
-
Fields inherited from interface org.w3c.dom.Node
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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DetailEntry
addDetailEntry(Name name)
Creates a newDetailEntry
object with the given name and adds it to thisDetail
object.DetailEntry
addDetailEntry(QName qname)
Creates a newDetailEntry
object with the given QName and adds it to thisDetail
object.Iterator<DetailEntry>
getDetailEntries()
Gets an Iterator over all of theDetailEntry
s in thisDetail
object.-
Methods inherited from interface org.w3c.dom.Element
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
-
Methods inherited from interface jakarta.xml.soap.Node
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
-
Methods inherited from interface org.w3c.dom.Node
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
-
Methods inherited from interface jakarta.xml.soap.SOAPElement
addAttribute, addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, createQName, getAllAttributes, getAllAttributesAsQNames, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildElements, getElementName, getElementQName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeAttribute, removeContents, removeNamespaceDeclaration, setElementQName, setEncodingStyle
-
-
-
-
Method Detail
-
addDetailEntry
DetailEntry addDetailEntry(Name name) throws SOAPException
Creates a newDetailEntry
object with the given name and adds it to thisDetail
object.- Parameters:
name
- aName
object identifying the newDetailEntry
object- Returns:
- the new
DetailEntry
object that was created - Throws:
SOAPException
- thrown when there is a problem in adding a DetailEntry object to this Detail object.- See Also:
addDetailEntry(QName qname)
-
addDetailEntry
DetailEntry addDetailEntry(QName qname) throws SOAPException
Creates a newDetailEntry
object with the given QName and adds it to thisDetail
object. This method is the preferred over the one using Name.- Parameters:
qname
- aQName
object identifying the newDetailEntry
object- Returns:
- the new
DetailEntry
object that was created - Throws:
SOAPException
- thrown when there is a problem in adding a DetailEntry object to this Detail object.- Since:
- 1.6, SAAJ 1.3
- See Also:
addDetailEntry(Name name)
-
getDetailEntries
Iterator<DetailEntry> getDetailEntries()
Gets an Iterator over all of theDetailEntry
s in thisDetail
object.- Returns:
- an
Iterator
object over theDetailEntry
objects in thisDetail
object
-
-