File	Doc	Category	Size	Date	Package
SOAPElement.java	API Doc	Apache Axis 1.4	12290	Sat Apr 22 18:57:26 BST 2006	javax.xml.soap

SOAPElement

Fields Summary

Constructors Summary

Methods Summary
public abstract javax.xml.soap.SOAPElement	addAttribute(javax.xml.soap.Name name, java.lang.String value) Adds an attribute with the specified name and value to this SOAPElement object. param name a Name object with the name of the attribute param value a String giving the value of the attribute return the SOAPElement object into which the attribute was inserted throws SOAPException if there is an error in creating the Attribute
public abstract javax.xml.soap.SOAPElement	addChildElement(javax.xml.soap.Name name) Creates a new SOAPElement object initialized with the given Name object and adds the new element to this SOAPElement object. param name a Name object with the XML name for the new element return the new SOAPElement object that was created throws SOAPException if there is an error in creating the SOAPElement object
public abstract javax.xml.soap.SOAPElement	addChildElement(java.lang.String localName) Creates a new SOAPElement object initialized with the given String object and adds the new element to this SOAPElement object. param localName a String giving the local name for the element return the new SOAPElement object that was created throws SOAPException if there is an error in creating the SOAPElement object
public abstract javax.xml.soap.SOAPElement	addChildElement(java.lang.String localName, java.lang.String prefix) Creates a new SOAPElement object initialized with the specified local name and prefix and adds the new element to this SOAPElement object. param localName a String giving the local name for the new element param prefix a String giving the namespace prefix for the new element return the new SOAPElement object that was created throws SOAPException if there is an error in creating the SOAPElement object
public abstract javax.xml.soap.SOAPElement	addChildElement(java.lang.String localName, java.lang.String prefix, java.lang.String uri) Creates a new SOAPElement object initialized with the specified local name, prefix, and URI and adds the new element to this SOAPElement object. param localName a String giving the local name for the new element param prefix a String giving the namespace prefix for the new element param uri a String giving the URI of the namespace to which the new element belongs return the new SOAPElement object that was created throws SOAPException if there is an error in creating the SOAPElement object
public abstract javax.xml.soap.SOAPElement	addChildElement(javax.xml.soap.SOAPElement element) 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. param element the SOAPElement to be added as a new child return an instance representing the new SOAP element that was actually added to the tree. throws SOAPException if there was an error in adding this element as a child
public abstract javax.xml.soap.SOAPElement	addNamespaceDeclaration(java.lang.String prefix, java.lang.String uri) Adds a namespace declaration with the specified prefix and URI to this SOAPElement object. param prefix a String giving the prefix of the namespace param uri a String giving the prefix of the namespace return the SOAPElement object into which this namespace declaration was inserted. throws SOAPException if there is an error in creating the namespace
public abstract javax.xml.soap.SOAPElement	addTextNode(java.lang.String text) Creates a new Text object initialized with the given String and adds it to this SOAPElement object. param text a String object with the textual content to be added return the SOAPElement object into which the new Text object was inserted throws SOAPException if there is an error in creating the new Text object
public abstract java.util.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. return an iterator over the names of the attributes
public abstract java.lang.String	getAttributeValue(javax.xml.soap.Name name) Returns the value of the attribute with the specified name. param name a Name object with the name of the attribute return a String giving the value of the specified attribute
public abstract java.util.Iterator	getChildElements() Returns an iterator over all the immediate content of this element. This includes Text objects as well as SOAPElement objects. return an iterator with the content of this SOAPElement object
public abstract java.util.Iterator	getChildElements(javax.xml.soap.Name name) Returns an iterator over all the child elements with the specified name. param name a Name object with the name of the child elements to be returned return an Iterator object over all the elements in this SOAPElement object with the specified name
public abstract javax.xml.soap.Name	getElementName() Returns the name of this SOAPElement object. return a Name object with the name of this SOAPElement object
public abstract java.lang.String	getEncodingStyle() Returns the encoding style for this SOAPElement object. return a String giving the encoding style see #setEncodingStyle(java.lang.String) setEncodingStyle(java.lang.String)
public abstract java.util.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. return an iterator over the namespace prefixes in this SOAPElement object
public abstract java.lang.String	getNamespaceURI(java.lang.String prefix) Returns the URI of the namespace that has the given prefix. param prefix a String giving the prefix of the namespace for which to search return a String with the uri of the namespace that has the given prefix
public abstract java.util.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. return an iterator over the namespace prefixes are within scope of this SOAPElement object
public abstract boolean	removeAttribute(javax.xml.soap.Name name) Removes the attribute with the specified name. param name the Name object with the name of the attribute to be removed return true if the attribute was removed successfully; false if it was not
public abstract 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.
public abstract boolean	removeNamespaceDeclaration(java.lang.String prefix) Removes the namespace declaration corresponding to the given prefix. param prefix a String giving the prefix for which to search return true if the namespace declaration was removed successfully; false if it was not
public abstract void	setEncodingStyle(java.lang.String encodingStyle) Sets the encoding style for this SOAPElement object to one specified. param encodingStyle a String giving the encoding style throws java.lang.IllegalArgumentException if there was a problem in the encoding style being set. see #getEncodingStyle() getEncodingStyle()