当前页面: 在线文档首页 > Java Platform, Enterprise Edition v1.4 API Specifications

SOAPBody (Java 2 Platform Ent. Ed. v1.4) - Java Platform, Enterprise Edition v1.4 API Specifications

Overview  Package   Class  Tree  Deprecated  Index  Help			JavaTM 2 Platform Ent. Ed. v1.4
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

javax.xml.soap
Interface SOAPBody

All Superinterfaces:

Element, Node, Node, SOAPElement

---

public interface SOAPBody

extends 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 Also:

SOAPFault

---

Field Summary

 

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

 

Method Summary
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.

 

Methods inherited from interface javax.xml.soap.SOAPElement

addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, getAllAttributes, getAttributeValue, getChildElements, getChildElements, getElementName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeContents, removeNamespaceDeclaration, setEncodingStyle

 

Methods inherited from interface javax.xml.soap.Node

detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue

 

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix

 

Methods inherited from interface org.w3c.dom.Element

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS

 

Method Detail

addFault

public SOAPFault addFault()
                   throws SOAPException

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 faultcode and faultstring.

A SOAPBody may contain at most one SOAPFault child element

Returns:

the new SOAPFault object

Throws:

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.

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 SOAP 1.1 specification and of type QName

faultString - a String giving an explanation of the fault

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

Returns:

the new SOAPFault object

Throws:

SOAPException - if there is a SOAP error

Since:

SAAJ 1.2

See Also:

SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String)

---

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.

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 SOAP 1.1 specification and of type QName

faultString - a String giving an explanation of the fault

Returns:

the new SOAPFault object

Throws:

SOAPException - if there is a SOAP error

Since:

SAAJ 1.2

See Also:

SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String)

---

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

---

addBodyElement

public SOAPBodyElement addBodyElement(Name name)
                               throws SOAPException

Creates a new SOAPBodyElement object with the specified name and adds it to this SOAPBody object.

Parameters:

name - a Name object with the name for the new SOAPBodyElement object

Returns:

the new SOAPBodyElement object

Throws:

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.

Parameters:

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

Returns:

the SOAPBodyElement that represents the root node that was added.

Throws:

SOAPException - if the Document cannot be added

Since:

SAAJ 1.2

---

Overview  Package   Class  Tree  Deprecated  Index  Help			JavaTM 2 Platform Ent. Ed. v1.4
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

Submit a bug or feature

Copyright 2003 Sun Microsystems, Inc. All rights reserved.