Save This Page
Home » xmlbeans-2.4.0-src » org.apache.xmlbeans.impl.soap » [javadoc | source]
org.apache.xmlbeans.impl.soap
public interface: SOAPElement [javadoc | source]

All Implemented Interfaces:
    Node, Element

All Known Implementing Classes:
    SoapHeaderXobj, SOAPHeader, SoapHeaderElementXobj, DetailXobj, SOAPBody, SoapFaultXobj, SOAPFaultElement, DetailEntry, SOAPBodyElement, SOAPEnvelope, SOAPFault, SoapBodyElementXobj, Detail, SoapBodyXobj, SoapFaultElementXobj, SOAPHeaderElement, SoapEnvelopeXobj, SoapElementXobj, DetailEntryXobj

An object representing the contents in a SOAPBody object, the contents in a SOAPHeader object, the content that can follow the SOAPBody object in a SOAPEnvelope object, or what can follow the detail element in a SOAPFault object. It is the base class for all of the classes that represent the SOAP objects as defined in the SOAP specification.
Method from org.apache.xmlbeans.impl.soap.SOAPElement Summary:
addAttribute,   addChildElement,   addChildElement,   addChildElement,   addChildElement,   addChildElement,   addNamespaceDeclaration,   addTextNode,   getAllAttributes,   getAttributeValue,   getChildElements,   getChildElements,   getElementName,   getEncodingStyle,   getNamespacePrefixes,   getNamespaceURI,   getVisibleNamespacePrefixes,   removeAttribute,   removeContents,   removeNamespaceDeclaration,   setEncodingStyle
Method from org.apache.xmlbeans.impl.soap.SOAPElement Detail:
 abstract public SOAPElement addAttribute(Name name,
    String value) throws SOAPException
    Adds an attribute with the specified name and value to this SOAPElement object.

 abstract public SOAPElement addChildElement(Name name) throws SOAPException
    Creates a new SOAPElement object initialized with the given Name object and adds the new element to this SOAPElement object.
 abstract public SOAPElement addChildElement(String localName) throws SOAPException
    Creates a new SOAPElement object initialized with the given String object and adds the new element to this SOAPElement object.
 abstract public SOAPElement addChildElement(SOAPElement element) throws SOAPException
    Add a SOAPElement as a child of this SOAPElement instance. The SOAPElement is expected to be created by a SOAPElementFactory. Callers should not rely on the element instance being added as is into the XML tree. Implementations could end up copying the content of the SOAPElement passed into an instance of a different SOAPElement implementation. For instance if addChildElement() is called on a SOAPHeader, element will be copied into an instance of a SOAPHeaderElement.

    The fragment rooted in element is either added as a whole or not at all, if there was an error.

    The fragment rooted in element cannot contain elements named "Envelope", "Header" or "Body" and in the SOAP namespace. Any namespace prefixes present in the fragment should be fully resolved using appropriate namespace declarations within the fragment itself.

 abstract public SOAPElement addChildElement(String localName,
    String prefix) throws SOAPException
    Creates a new SOAPElement object initialized with the specified local name and prefix and adds the new element to this SOAPElement object.
 abstract public SOAPElement addChildElement(String localName,
    String prefix,
    String uri) throws SOAPException
    Creates a new SOAPElement object initialized with the specified local name, prefix, and URI and adds the new element to this SOAPElement object.
 abstract public SOAPElement addNamespaceDeclaration(String prefix,
    String uri) throws SOAPException
    Adds a namespace declaration with the specified prefix and URI to this SOAPElement object.

 abstract public SOAPElement addTextNode(String text) throws SOAPException
    Creates a new Text object initialized with the given String and adds it to this SOAPElement object.
 abstract public Iterator getAllAttributes()
    Returns an iterator over all of the attribute names in this SOAPElement object. The iterator can be used to get the attribute names, which can then be passed to the method getAttributeValue to retrieve the value of each attribute.
 abstract public String getAttributeValue(Name name)
    Returns the value of the attribute with the specified name.
 abstract public Iterator getChildElements()
    Returns an iterator over all the immediate content of this element. This includes Text objects as well as SOAPElement objects.
 abstract public Iterator getChildElements(Name name)
    Returns an iterator over all the child elements with the specified name.
 abstract public Name getElementName()
    Returns the name of this SOAPElement object.
 abstract public String getEncodingStyle()
    Returns the encoding style for this SOAPElement object.
 abstract public Iterator getNamespacePrefixes()
    Returns an iterator of namespace prefixes. The iterator can be used to get the namespace prefixes, which can then be passed to the method getNamespaceURI to retrieve the URI of each namespace.
 abstract public String getNamespaceURI(String prefix)
    Returns the URI of the namespace that has the given prefix.
 abstract public Iterator getVisibleNamespacePrefixes()
    Returns an Iterator over the namespace prefix Strings visible to this element. The prefixes returned by this iterator can be passed to the method getNamespaceURI() to retrieve the URI of each namespace.
 abstract public boolean removeAttribute(Name name)
    Removes the attribute with the specified name.
 abstract public  void removeContents()
    Detaches all children of this SOAPElement.

    This method is useful for rolling back the construction of partially completed SOAPHeaders and SOAPBodys in reparation for sending a fault when an error condition is detected. It is also useful for recycling portions of a document within a SOAP message.

 abstract public boolean removeNamespaceDeclaration(String prefix)
    Removes the namespace declaration corresponding to the given prefix.
 abstract public  void setEncodingStyle(String encodingStyle) throws SOAPException
    Sets the encoding style for this SOAPElement object to one specified.