org.apache.axiom.soap
Interface SOAPBody

All Superinterfaces:

OMContainer, OMElement, OMNode

All Known Implementing Classes:

SOAPBodyImpl, SOAPBodyImpl

public interface SOAPBody

extends OMElement

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

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

Field Summary

Fields inherited from interface org.apache.axiom.om.OMNode

CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE

Method Summary

SOAPFault	addFault(java.lang.Exception e) Creates a new SOAPFault object and adds it to this SOAPBody object.
void	addFault(SOAPFault soapFault)
SOAPFault	getFault() Returns the SOAPFault object in this SOAPBody object.
boolean	hasFault() Indicates whether a SOAPFault object exists in this SOAPBody object.

Methods inherited from interface org.apache.axiom.om.OMElement

addAttribute, addAttribute, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getBuilder, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getLocalName, getNamespace, getQName, getText, getTextAsQName, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeAttribute, resolveQName, setBuilder, setFirstChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume

Methods inherited from interface org.apache.axiom.om.OMNode

build, detach, discard, getNextOMSibling, getOMFactory, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore, isComplete, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMContainer

addChild, buildNext, getChildren, getChildrenWithName, getFirstChildWithName, getFirstOMChild, isComplete

Method Detail

addFault

public SOAPFault addFault(java.lang.Exception e)
                   throws OMException

Creates a new SOAPFault object and adds it to this SOAPBody object.

Parameters:

e -

Returns:

the new SOAPFault object

Throws:

OMException - if there is a SOAP error

OMException

hasFault

public boolean hasFault()

Indicates whether a SOAPFault object exists in this SOAPBody object.

Returns:

true if a SOAPFault object exists in this SOAPBody object; false otherwise

getFault

public SOAPFault getFault()

Returns the SOAPFault object in this SOAPBody object.

Returns:

the SOAPFault object in this SOAPBody object

addFault

public void addFault(SOAPFault soapFault)
              throws OMException

Parameters:

soapFault -

Throws:

OMException