org.apache.axis2.saaj
Class DetailImpl

java.lang.Object
  extended by org.apache.axiom.om.impl.dom.NodeImpl
      extended by org.apache.axis2.saaj.NodeImplEx
          extended by org.apache.axis2.saaj.SOAPElementImpl
              extended by org.apache.axis2.saaj.SOAPFaultElementImpl
                  extended by org.apache.axis2.saaj.DetailImpl
All Implemented Interfaces:
java.lang.Cloneable, org.apache.axiom.om.impl.OMNodeEx, org.apache.axiom.om.OMNode, org.w3c.dom.Node, org.w3c.dom.NodeList

public class DetailImpl
extends SOAPFaultElementImpl

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 new DetailEntry object and also automatically adds it to the Detail object. The second method gets a list of the DetailEntry objects contained in a Detail object.

The following code fragment, in which sf is a SOAPFault object, gets its Detail object (d), adds a new DetailEntry object to d, and then gets a list of all the DetailEntry objects in d. The code also creates a Name 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 class org.apache.axis2.saaj.SOAPElementImpl
element
 
Fields inherited from class org.apache.axis2.saaj.NodeImplEx
parentElement
 
Fields inherited from class org.apache.axiom.om.impl.dom.NodeImpl
builder, done, factory, FIRSTCHILD, flags, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED
 
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
 
Fields inherited from interface org.apache.axiom.om.OMNode
DTD_NODE, PI_NODE, SPACE_NODE
 
Constructor Summary
DetailImpl(org.apache.axiom.soap.SOAPFaultDetail element)
           
 
Method Summary
 SOAPElement addAttribute(javax.xml.namespace.QName qname, java.lang.String value)
          Adds an attribute with the specified name and value to this SOAPElement object.
 SOAPElement addChildElement(javax.xml.namespace.QName qname)
           
 DetailEntry addDetailEntry(Name name)
          Creates a new DetailEntry object with the given name and adds it to this Detail object.
 javax.xml.namespace.QName createQName(java.lang.String localName, java.lang.String prefix)
          Creates a QName whose namespace URI is the one associated with the parameter, prefix, in the context of this SOAPElement.
 java.util.Iterator getAllAttributesAsQNames()
           
 java.lang.String getAttributeValue(javax.xml.namespace.QName qname)
           
 java.util.Iterator getChildElements(javax.xml.namespace.QName qname)
           
 java.util.Iterator getDetailEntries()
          Gets a list of the detail entries in this Detail object.
 javax.xml.namespace.QName getElementQName()
           
 boolean removeAttribute(javax.xml.namespace.QName qname)
           
 SOAPElement setElementQName(javax.xml.namespace.QName newName)
           
 
Methods inherited from class org.apache.axis2.saaj.SOAPElementImpl
addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, appendChild, appendElement, appendText, copyContents, detach, detachNode, discard, getAllAttributes, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getChildElements, getChildNodes, getElement, getElementName, getElementsByTagName, getElementsByTagNameNS, getEncodingStyle, getFirstChild, getLastChild, getLocalName, getNamespacePrefixes, getNamespaceURI, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPreviousSibling, getTagName, getValue, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, hasChildNodes, internalSerialize, internalSerializeAndConsume, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeContents, removeNamespaceDeclaration, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setEncodingStyle, setParent, setParentElement, setValue, toString
 
Methods inherited from class org.apache.axis2.saaj.NodeImplEx
getParent, getSchemaTypeInfo, getType, recycleNode, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setType
 
Methods inherited from class org.apache.axiom.om.impl.dom.NodeImpl
build, buildWithAttachments, cloneNode, close, compareDocumentPosition, getBaseURI, getFeature, getLength, getNextOMSibling, getNodeValue, getOMFactory, getPreviousOMSibling, getTextContent, getUserData, hasAttributes, insertBefore, insertSiblingAfter, insertSiblingBefore, internalSerializeWithCache, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, replaceChild, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setNodeValue, setOwnerDocument, setPrefix, setPreviousOMSibling, setTextContent, setUserData
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DetailImpl

public DetailImpl(org.apache.axiom.soap.SOAPFaultDetail element)
Parameters:
element -
Method Detail

addDetailEntry

public 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
Returns:
DetailEntry.
Throws:
SOAPException - thrown when there is a problem in adding a DetailEntry object to this Detail object.

getDetailEntries

public java.util.Iterator getDetailEntries()
Gets a list of the detail entries in this Detail object.

Returns:
an Iterator object over the DetailEntry objects in this Detail object

addAttribute

public SOAPElement addAttribute(javax.xml.namespace.QName qname,
                                java.lang.String value)
                         throws SOAPException
Description copied from class: SOAPElementImpl
Adds an attribute with the specified name and value to this SOAPElement object.

Overrides:
addAttribute in class SOAPElementImpl
Parameters:
qname - a Name object with the name of the attribute
value - a String giving the value of the attribute
Returns:
the SOAPElement object into which the attribute was inserted
Throws:
SOAPException - if there is an error in creating the Attribute

addChildElement

public SOAPElement addChildElement(javax.xml.namespace.QName qname)
                            throws SOAPException
Overrides:
addChildElement in class SOAPElementImpl
Throws:
SOAPException

createQName

public javax.xml.namespace.QName createQName(java.lang.String localName,
                                             java.lang.String prefix)
                                      throws SOAPException
Description copied from class: SOAPElementImpl
Creates a QName whose namespace URI is the one associated with the parameter, prefix, in the context of this SOAPElement. The remaining elements of the new QName are taken directly from the parameters, localName and prefix.

Overrides:
createQName in class SOAPElementImpl
Parameters:
localName - - a String containing the local part of the name. prefix - a String containing the prefix for the name.
Returns:
a QName with the specified localName and prefix, and with a namespace that is associated with the prefix in the context of this SOAPElement. This namespace will be the same as the one that would be returned by getNamespaceURI(String) if it were given prefix as its parameter.
Throws:
SOAPException - - if the QName cannot be created.

getAllAttributesAsQNames

public java.util.Iterator getAllAttributesAsQNames()
Overrides:
getAllAttributesAsQNames in class SOAPElementImpl

getAttributeValue

public java.lang.String getAttributeValue(javax.xml.namespace.QName qname)
Overrides:
getAttributeValue in class SOAPElementImpl

getChildElements

public java.util.Iterator getChildElements(javax.xml.namespace.QName qname)
Overrides:
getChildElements in class SOAPElementImpl

getElementQName

public javax.xml.namespace.QName getElementQName()
Overrides:
getElementQName in class SOAPElementImpl

removeAttribute

public boolean removeAttribute(javax.xml.namespace.QName qname)
Overrides:
removeAttribute in class SOAPElementImpl

setElementQName

public SOAPElement setElementQName(javax.xml.namespace.QName newName)
                            throws SOAPException
Overrides:
setElementQName in class SOAPElementImpl
Throws:
SOAPException


Copyright © 2007 Apache Web Services Project. All Rights Reserved.