Detail (Java Platform SE 6) (original) (raw)

javax.xml.soap

Interface Detail

All Superinterfaces:

Element, Node, SOAPElement, SOAPFaultElement

public interface Detail

extends SOAPFaultElement

A container for DetailEntry objects. DetailEntry objects give detailed error information that is application-specific and related to the SOAPBody object that contains it.

A Detail object, which is part of a SOAPFault object, can be retrieved using the method SOAPFault.getDetail. The Detail interface provides two methods. One creates a newDetailEntry object and also automatically adds it to the Detail object. The second method gets a list of theDetailEntry objects contained in a Detail object.

The following code fragment, in which sf is a SOAPFault object, gets its Detail 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 method addDetailEntry. The variable se, used to create the Name object, is a SOAPEnvelope object.

Detail d = sf.getDetail();
Name name = se.createName("GetLastTradePrice", "WOMBAT",
                            "http://www.wombat.org/trader");
d.addDetailEntry(name);
Iterator it = d.getDetailEntries();
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
DetailEntry addDetailEntry(Name name) Creates a new DetailEntry object with the given name and adds it to this Detail object.
DetailEntry addDetailEntry(QName qname) Creates a new DetailEntry object with the given QName and adds it to this Detail object.
Iterator getDetailEntries() Gets an Iterator over all of the DetailEntrys in this Detail object.
Methods inherited from interface javax.xml.soap.SOAPElement
[addAttribute](../../../javax/xml/soap/SOAPElement.html#addAttribute%28javax.xml.soap.Name, java.lang.String%29), [addAttribute](../../../javax/xml/soap/SOAPElement.html#addAttribute%28javax.xml.namespace.QName, java.lang.String%29), addChildElement, addChildElement, addChildElement, addChildElement, [addChildElement](../../../javax/xml/soap/SOAPElement.html#addChildElement%28java.lang.String, java.lang.String%29), [addChildElement](../../../javax/xml/soap/SOAPElement.html#addChildElement%28java.lang.String, java.lang.String, java.lang.String%29), [addNamespaceDeclaration](../../../javax/xml/soap/SOAPElement.html#addNamespaceDeclaration%28java.lang.String, java.lang.String%29), addTextNode, [createQName](../../../javax/xml/soap/SOAPElement.html#createQName%28java.lang.String, java.lang.String%29), getAllAttributes, getAllAttributesAsQNames, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildElements, getElementName, getElementQName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeAttribute, removeContents, removeNamespaceDeclaration, setElementQName, setEncodingStyle
Methods inherited from interface javax.xml.soap.Node
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
Methods inherited from interface org.w3c.dom.Element
getAttribute, getAttributeNode, [getAttributeNodeNS](../../../org/w3c/dom/Element.html#getAttributeNodeNS%28java.lang.String, java.lang.String%29), [getAttributeNS](../../../org/w3c/dom/Element.html#getAttributeNS%28java.lang.String, java.lang.String%29), getElementsByTagName, [getElementsByTagNameNS](../../../org/w3c/dom/Element.html#getElementsByTagNameNS%28java.lang.String, java.lang.String%29), getSchemaTypeInfo, getTagName, hasAttribute, [hasAttributeNS](../../../org/w3c/dom/Element.html#hasAttributeNS%28java.lang.String, java.lang.String%29), removeAttribute, removeAttributeNode, [removeAttributeNS](../../../org/w3c/dom/Element.html#removeAttributeNS%28java.lang.String, java.lang.String%29), [setAttribute](../../../org/w3c/dom/Element.html#setAttribute%28java.lang.String, java.lang.String%29), setAttributeNode, setAttributeNodeNS, [setAttributeNS](../../../org/w3c/dom/Element.html#setAttributeNS%28java.lang.String, java.lang.String, java.lang.String%29), [setIdAttribute](../../../org/w3c/dom/Element.html#setIdAttribute%28java.lang.String, boolean%29), [setIdAttributeNode](../../../org/w3c/dom/Element.html#setIdAttributeNode%28org.w3c.dom.Attr, boolean%29), [setIdAttributeNS](../../../org/w3c/dom/Element.html#setIdAttributeNS%28java.lang.String, java.lang.String, boolean%29)
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, [getFeature](../../../org/w3c/dom/Node.html#getFeature%28java.lang.String, java.lang.String%29), getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, [insertBefore](../../../org/w3c/dom/Node.html#insertBefore%28org.w3c.dom.Node, org.w3c.dom.Node%29), isDefaultNamespace, isEqualNode, isSameNode, [isSupported](../../../org/w3c/dom/Node.html#isSupported%28java.lang.String, java.lang.String%29), lookupNamespaceURI, lookupPrefix, normalize, removeChild, [replaceChild](../../../org/w3c/dom/Node.html#replaceChild%28org.w3c.dom.Node, org.w3c.dom.Node%29), setNodeValue, setPrefix, setTextContent, [setUserData](../../../org/w3c/dom/Node.html#setUserData%28java.lang.String, java.lang.Object, org.w3c.dom.UserDataHandler%29)
Method Detail

addDetailEntry

DetailEntry addDetailEntry(Name name) throws SOAPException

Creates a new DetailEntry object with the given name and adds it to this Detail object.

Parameters:

name - a Name object identifying the new DetailEntry object

Throws:

[SOAPException](../../../javax/xml/soap/SOAPException.html "class in javax.xml.soap") - 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 new DetailEntry object with the given QName and adds it to this Detail object. This method is the preferred over the one using Name.

Parameters:

qname - a QName object identifying the new DetailEntry object

Throws:

[SOAPException](../../../javax/xml/soap/SOAPException.html "class in javax.xml.soap") - thrown when there is a problem in adding a DetailEntry object to this Detail object.

Since:

SAAJ 1.3

See Also:

addDetailEntry(Name name)

getDetailEntries

Iterator getDetailEntries()

Gets an Iterator over all of the DetailEntrys in this Detail object.

Returns:

an Iterator object over the DetailEntry objects in this Detail object

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.