Package org.apache.axis2.saaj

Class DetailImpl

java.lang.Object
org.apache.axis2.saaj.ProxyNode<T,S>
org.apache.axis2.saaj.NodeImpl<Element,T>
org.apache.axis2.saaj.SOAPElementImpl<T>
org.apache.axis2.saaj.SOAPFaultElementImpl<org.apache.axiom.soap.SOAPFaultDetail>
org.apache.axis2.saaj.DetailImpl
All Implemented Interfaces:
jakarta.xml.soap.Detail, jakarta.xml.soap.Node, jakarta.xml.soap.SOAPElement, jakarta.xml.soap.SOAPFaultElement, Element, Node
public class DetailImpl extends SOAPFaultElementImpl<org.apache.axiom.soap.SOAPFaultDetail> implements jakarta.xml.soap.Detail
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();

  • Constructor Details

    • DetailImpl

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

  • Method Details

    • addDetailEntry

      public jakarta.xml.soap.DetailEntry addDetailEntry(jakarta.xml.soap.Name name) throws jakarta.xml.soap.SOAPException
      Creates a new DetailEntry object with the given name and adds it to this Detail object.
      Specified by:
      addDetailEntry in interface jakarta.xml.soap.Detail
      Parameters:
      name - a Name object identifying the new DetailEntry object
      Returns:
      DetailEntry.
      Throws:
      jakarta.xml.soap.SOAPException - thrown when there is a problem in adding a DetailEntry object to this Detail object.

    • getDetailEntries

      public Iterator getDetailEntries()
      Gets a list of the detail entries in this Detail object.
      Specified by:
      getDetailEntries in interface jakarta.xml.soap.Detail
      Returns:
      an Iterator object over the DetailEntry objects in this Detail object

    • addDetailEntry

      public jakarta.xml.soap.DetailEntry addDetailEntry(QName qname) throws jakarta.xml.soap.SOAPException
      Creates a new DetailEntry object with the given name and adds it to this Detail object.
      Specified by:
      addDetailEntry in interface jakarta.xml.soap.Detail
      Parameters:
      name - - a Name object identifying the new DetailEntry object
      Throws:
      jakarta.xml.soap.SOAPException - - thrown when there is a problem in adding a DetailEntry object to this Detail object.

    • addAttribute

      public jakarta.xml.soap.SOAPElement addAttribute(QName qname, String value) throws jakarta.xml.soap.SOAPException
      Specified by:
      addAttribute in interface jakarta.xml.soap.SOAPElement
      Overrides:
      addAttribute in class SOAPElementImpl<org.apache.axiom.soap.SOAPFaultDetail>
      Throws:
      jakarta.xml.soap.SOAPException

    • addChildElement

      public jakarta.xml.soap.SOAPElement addChildElement(QName qname) throws jakarta.xml.soap.SOAPException
      Specified by:
      addChildElement in interface jakarta.xml.soap.SOAPElement
      Overrides:
      addChildElement in class SOAPElementImpl<org.apache.axiom.soap.SOAPFaultDetail>
      Throws:
      jakarta.xml.soap.SOAPException

    • createQName

      public QName createQName(String localName, String prefix) throws jakarta.xml.soap.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.
      Specified by:
      createQName in interface jakarta.xml.soap.SOAPElement
      Overrides:
      createQName in class SOAPElementImpl<org.apache.axiom.soap.SOAPFaultDetail>
      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:
      jakarta.xml.soap.SOAPException - - if the QName cannot be created.

    • getAllAttributesAsQNames

      public Iterator getAllAttributesAsQNames()
      Specified by:
      getAllAttributesAsQNames in interface jakarta.xml.soap.SOAPElement
      Overrides:
      getAllAttributesAsQNames in class SOAPElementImpl<org.apache.axiom.soap.SOAPFaultDetail>

    • getAttributeValue

      public String getAttributeValue(QName qname)
      Specified by:
      getAttributeValue in interface jakarta.xml.soap.SOAPElement
      Overrides:
      getAttributeValue in class SOAPElementImpl<org.apache.axiom.soap.SOAPFaultDetail>

    • getChildElements

      public Iterator getChildElements(QName qname)
      Specified by:
      getChildElements in interface jakarta.xml.soap.SOAPElement
      Overrides:
      getChildElements in class SOAPElementImpl<org.apache.axiom.soap.SOAPFaultDetail>

    • getElementQName

      public QName getElementQName()
      Specified by:
      getElementQName in interface jakarta.xml.soap.SOAPElement
      Overrides:
      getElementQName in class SOAPElementImpl<org.apache.axiom.soap.SOAPFaultDetail>

    • removeAttribute

      public boolean removeAttribute(QName qname)
      Specified by:
      removeAttribute in interface jakarta.xml.soap.SOAPElement
      Overrides:
      removeAttribute in class SOAPElementImpl<org.apache.axiom.soap.SOAPFaultDetail>

    • setElementQName

      public jakarta.xml.soap.SOAPElement setElementQName(QName newName) throws jakarta.xml.soap.SOAPException
      Specified by:
      setElementQName in interface jakarta.xml.soap.SOAPElement
      Overrides:
      setElementQName in class SOAPElementImpl<org.apache.axiom.soap.SOAPFaultDetail>
      Throws:
      jakarta.xml.soap.SOAPException