javax.xml.soap
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.

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.

addFault

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.

Parameters:

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

faultString - a String giving an explanation of
the fault

locale - a Locale object indicating
the native language of the faultString

addFault

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.

Parameters:

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.

faultString - a String giving an explanation of the fault

locale - a Locale object indicating the
native language of the faultString

addFault

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.

Parameters:

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

addFault

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

Parameters:

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

addDocument

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.

Parameters:

document - the Document object whose root node will be
added to this SOAPBody.