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

SOAPBody

public interface SOAPBody implements SOAPElement

An object that represents the contents of the SOAP body element in a SOAP message. A SOAP body element consists of XML data that affects the way the application-specific content is processed.

A SOAPBody object contains SOAPBodyElement objects, which have the content for the SOAP body. A SOAPFault object, which carries status and/or error information, is an example of a SOAPBodyElement object.

see: SOAPFault SOAPFault

Fields Summary
Constructors Summary
Methods Summary
public abstract 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
throws
SOAPException if a SOAP error occurs
public abstract javax.xml.soap.SOAPBodyElement addDocument(org.w3c.dom.Document document)
Adds the root node of the 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
throws
SOAPException if the Document cannot be added
public abstract javax.xml.soap.SOAPFault addFault()
Creates a new SOAPFault object and adds it to this SOAPBody object.
return
the new SOAPFault object
throws
SOAPException if there is a SOAP error
public abstract 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 new SOAPFault will have a faultcode element that is set to the faultCode parameter and a faultstring set to faultstring and localized to locale.
param
faultCode a Name object giving the fault code to be set; must be one of the fault codes defined in the SOAP 1.1 specification and of type QName
param
faultString a String giving an explanation of the fault
param
locale a Locale object indicating the native language of the faultString
return
the new SOAPFault object
throws
SOAPException if there is a SOAP error
public abstract 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 new SOAPFault will have a faultcode element that is set to the faultCode parameter and a faultstring set to faultstring.
param
faultCode a Name object giving the fault code to be set; must be one of the fault codes defined in the SOAP 1.1 specification and of type QName
param
faultString a String giving an explanation of the fault
return
the new SOAPFault object
throws
SOAPException if there is a SOAP error
public abstract javax.xml.soap.SOAPFault getFault()
Returns the SOAPFault object in this SOAPBody object.
return
the SOAPFault object in this SOAPBody object
public abstract 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