javax.xml.soap
Interface SOAPBody
- org.w3c.dom.Element, Node, SOAPElement
- SOAPBody
public interface SOAPBody
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.
SOAPFault
SOAPBodyElement | addBodyElement(Name name) - Creates a new
SOAPBodyElement object with the
specified name and adds it to this SOAPBody object.
|
SOAPBodyElement | addDocument(Document document) - Adds the root node of the DOM
Document to this
SOAPBody object.
|
SOAPFault | addFault() - Creates a new
SOAPFault object and adds it to
this SOAPBody object.
|
SOAPFault | addFault(Name faultCode, String faultString) - Creates a new
SOAPFault object and adds it to this
SOAPBody object.
|
SOAPFault | addFault(Name faultCode, String faultString, Locale locale) - Creates a new
SOAPFault object and adds it to this
SOAPBody object.
|
SOAPFault | getFault() - Returns the
SOAPFault object in this SOAPBody
object.
|
boolean | hasFault() - Indicates whether a
SOAPFault object exists in
this SOAPBody object.
|
addAttribute , addChildElement , addChildElement , addChildElement , addChildElement , addChildElement , addNamespaceDeclaration , addTextNode , getAllAttributes , getAttributeValue , getChildElements , getChildElements , getElementName , getEncodingStyle , getNamespacePrefixes , getNamespaceURI , getVisibleNamespacePrefixes , removeAttribute , removeContents , removeNamespaceDeclaration , setEncodingStyle |
addBodyElement
public SOAPBodyElement addBodyElement(Name name)
throws SOAPException
Creates a new SOAPBodyElement
object with the
specified name and adds it to this SOAPBody
object.
name
- a Name
object with the name for the new
SOAPBodyElement
object
- the new
SOAPBodyElement
object
SOAPException
- if a SOAP error occurs
addDocument
public SOAPBodyElement addDocument(Document document)
throws SOAPException
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.
document
- the Document
object whose root node will be
added to this SOAPBody
- the
SOAPBodyElement
that represents the root node
that was added
SOAPException
- if the Document
cannot be added
addFault
public SOAPFault addFault()
throws SOAPException
Creates a new SOAPFault
object and adds it to
this SOAPBody
object.
- the new
SOAPFault
object
SOAPException
- if there is a SOAP error
addFault
public SOAPFault addFault(Name faultCode,
String faultString)
throws SOAPException
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
.
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 QNamefaultString
- a String
giving an explanation of the
fault
- the new
SOAPFault
object
SOAPException
- if there is a SOAP error
addFault
public SOAPFault addFault(Name faultCode,
String faultString,
Locale locale)
throws SOAPException
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
.
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 QNamefaultString
- a String
giving an explanation of the
faultlocale
- a Locale
object indicating the native language
of the faultString
- the new
SOAPFault
object
SOAPException
- if there is a SOAP error
getFault
public SOAPFault getFault()
Returns the SOAPFault
object in this SOAPBody
object.
- the
SOAPFault
object in this SOAPBody
object
hasFault
public boolean hasFault()
Indicates whether a SOAPFault
object exists in
this SOAPBody
object.
true
if a SOAPFault
object exists in
this SOAPBody
object; false
otherwise
Copyright B) 2005 Apache Web Services Project. All Rights Reserved.