javax.xml.soap
Interface SOAPFault

All Superinterfaces:
org.w3c.dom.Element, Node (src) , org.w3c.dom.Node, SOAPBodyElement (src) , SOAPElement (src)
All Known Implementing Classes:
SOAPFaultImpl (src)

public interface SOAPFault
extends SOAPBodyElement (src)

An element in the SOAPBody object that contains error and/or status information. This information may relate to errors in the SOAPMessage object or to problems that are not related to the content in the message itself. Problems not related to the message itself are generally errors in processing, such as the inability to communicate with an upstream server. The SOAPFault interface provides methods for retrieving the information contained in a SOAPFault object and for setting the fault code, the fault actor, and a string describing the fault. A fault code is one of the codes defined in the SOAP 1.1 specification that describe the fault. An actor is an intermediate recipient to whom a message was routed. The message path may include one or more actors, or, if no actors are specified, the message goes only to the default actor, which is the final intended recipient.


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
 Detail (src) addDetail()
           
 Detail (src) getDetail()
           
 java.lang.String getFaultActor()
           
 java.lang.String getFaultCode()
           
 Name (src) getFaultCodeAsName()
           
 java.lang.String getFaultString()
           
 java.util.Locale getFaultStringLocale()
           
 void setFaultActor(java.lang.String faultActor)
           
 void setFaultCode(Name (src)  faultCodeQName)
           
 void setFaultCode(java.lang.String faultCode)
           
 void setFaultString(java.lang.String faultString)
           
 void setFaultString(java.lang.String faultString, java.util.Locale locale)
           
 
Methods inherited from interface javax.xml.soap.SOAPElement (src)
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 (src)
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

addDetail

public Detail (src)  addDetail()
                 throws SOAPException (src) 
Throws:
SOAPException (src)

getDetail

public Detail (src)  getDetail()

getFaultActor

public java.lang.String getFaultActor()

getFaultCode

public java.lang.String getFaultCode()

getFaultCodeAsName

public Name (src)  getFaultCodeAsName()

getFaultString

public java.lang.String getFaultString()

getFaultStringLocale

public java.util.Locale getFaultStringLocale()

setFaultActor

public void setFaultActor(java.lang.String faultActor)
                   throws SOAPException (src) 
Throws:
SOAPException (src)

setFaultCode

public void setFaultCode(java.lang.String faultCode)
                  throws SOAPException (src) 
Throws:
SOAPException (src)

setFaultCode

public void setFaultCode(Name (src)  faultCodeQName)
                  throws SOAPException (src) 
Throws:
SOAPException (src)

setFaultString

public void setFaultString(java.lang.String faultString)
                    throws SOAPException (src) 
Throws:
SOAPException (src)

setFaultString

public void setFaultString(java.lang.String faultString,
                           java.util.Locale locale)
                    throws SOAPException (src) 
Throws:
SOAPException (src)