File	Doc	Category	Size	Date	Package
SOAPBody.java	API Doc	Java SE 6 API	12975	Tue Jun 10 00:27:10 BST 2008	javax.xml.soap

SOAPBody

Fields Summary

Constructors Summary

Methods Summary
public javax.xml.soap.SOAPBodyElement	addBodyElement(javax.xml.soap.Name name) Creates a new SOAPBodyElement object with the specified name and adds it to this SOAPBody object. param name a Name object with the name for the new SOAPBodyElement object return the new SOAPBodyElement object exception SOAPException if a SOAP error occurs see SOAPBody#addBodyElement(javax.xml.namespace.QName)
public javax.xml.soap.SOAPBodyElement	addBodyElement(javax.xml.namespace.QName qname) Creates a new SOAPBodyElement object with the specified QName and adds it to this SOAPBody object. param qname a QName object with the qname for the new SOAPBodyElement object return the new SOAPBodyElement object exception SOAPException if a SOAP error occurs see SOAPBody#addBodyElement(Name) since SAAJ 1.3
public javax.xml.soap.SOAPBodyElement	addDocument(org.w3c.dom.Document document) Adds the root node of the DOM {@link org.w3c.dom.Document} to this SOAPBody object. Calling this method invalidates the document parameter. The client application should discard all references to this Document and its contents upon calling addDocument. The behavior of an application that continues to use such references is undefined. param document the Document object whose root node will be added to this SOAPBody. return the SOAPBodyElement that represents the root node that was added. exception SOAPException if the Document cannot be added since SAAJ 1.2
public javax.xml.soap.SOAPFault	addFault() Creates a new SOAPFault object and adds it to this SOAPBody object. The new SOAPFault will have default values set for the mandatory child elements. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance. A SOAPBody may contain at most one SOAPFault child element. return the new SOAPFault object exception SOAPException if there is a SOAP error
public javax.xml.soap.SOAPFault	addFault(javax.xml.soap.Name faultCode, java.lang.String faultString, java.util.Locale locale) Creates a new SOAPFault object and adds it to this SOAPBody object. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance. For SOAP 1.2 the faultCode parameter is the value of the Fault/Code/Value element and the faultString parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 the faultCode parameter is the value of the faultcode element and the faultString parameter is the value of the faultstring element. A SOAPBody may contain at most one SOAPFault child element. param faultCode a Name object giving the fault code to be set; must be one of the fault codes defined in the Version of SOAP specification in use param faultString a String giving an explanation of the fault param locale a {@link java.util.Locale} object indicating the native language of the faultString return the new SOAPFault object exception SOAPException if there is a SOAP error see SOAPFault#setFaultCode see SOAPFault#setFaultString since SAAJ 1.2
public javax.xml.soap.SOAPFault	addFault(javax.xml.namespace.QName faultCode, java.lang.String faultString, java.util.Locale locale) Creates a new SOAPFault object and adds it to this SOAPBody object. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance. For SOAP 1.2 the faultCode parameter is the value of the Fault/Code/Value element and the faultString parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 the faultCode parameter is the value of the faultcode element and the faultString parameter is the value of the faultstring element. A SOAPBody may contain at most one SOAPFault child element. param faultCode a QName object giving the fault code to be set; must be one of the fault codes defined in the version of SOAP specification in use. param faultString a String giving an explanation of the fault param locale a {@link java.util.Locale Locale} object indicating the native language of the faultString return the new SOAPFault object exception SOAPException if there is a SOAP error see SOAPFault#setFaultCode see SOAPFault#setFaultString see SOAPBody#addFault(Name faultCode, String faultString, Locale locale) since SAAJ 1.3
public javax.xml.soap.SOAPFault	addFault(javax.xml.soap.Name faultCode, java.lang.String faultString) Creates a new SOAPFault object and adds it to this SOAPBody object. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance. For SOAP 1.2 the faultCode parameter is the value of the Fault/Code/Value element and the faultString parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 the faultCode parameter is the value of the faultcode element and the faultString parameter is the value of the faultstring element. In case of a SOAP 1.2 fault, the default value for the mandatory xml:lang attribute on the Fault/Reason/Text element will be set to java.util.Locale.getDefault() A SOAPBody may contain at most one SOAPFault child element. param faultCode a Name object giving the fault code to be set; must be one of the fault codes defined in the version of SOAP specification in use param faultString a String giving an explanation of the fault return the new SOAPFault object exception SOAPException if there is a SOAP error see SOAPFault#setFaultCode see SOAPFault#setFaultString since SAAJ 1.2
public javax.xml.soap.SOAPFault	addFault(javax.xml.namespace.QName faultCode, java.lang.String faultString) Creates a new SOAPFault object and adds it to this SOAPBody object. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance. For SOAP 1.2 the faultCode parameter is the value of the Fault/Code/Value element and the faultString parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 the faultCode parameter is the value of the faultcode element and the faultString parameter is the value of the faultstring element. In case of a SOAP 1.2 fault, the default value for the mandatory xml:lang attribute on the Fault/Reason/Text element will be set to java.util.Locale.getDefault() A SOAPBody may contain at most one SOAPFault child element param faultCode a QName object giving the fault code to be set; must be one of the fault codes defined in the version of SOAP specification in use param faultString a String giving an explanation of the fault return the new SOAPFault object exception SOAPException if there is a SOAP error see SOAPFault#setFaultCode see SOAPFault#setFaultString see SOAPBody#addFault(Name faultCode, String faultString) since SAAJ 1.3
public org.w3c.dom.Document	extractContentAsDocument() Creates a new DOM {@link org.w3c.dom.Document} and sets the first child of this SOAPBody as it's document element. The child SOAPElement is removed as part of the process. return the {@link org.w3c.dom.Document} representation of the SOAPBody content. exception SOAPException if there is not exactly one child SOAPElement of the SOAPBody. since SAAJ 1.3
public javax.xml.soap.SOAPFault	getFault() Returns the SOAPFault object in this SOAPBody object. return the SOAPFault object in this SOAPBody object if present, null otherwise.
public boolean	hasFault() Indicates whether a SOAPFault object exists in this SOAPBody object. return true if a SOAPFault object exists in this SOAPBody object; false otherwise