Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.xml.soap
Interface SOAPFault

All Superinterfaces:
  Element, Node, Node, SOAPBodyElement, SOAPElement

public interface SOAPFault
extends SOAPBodyElement

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.

Version:
  $Revision: 1.1 $
Author:
  Scott.Stark@jboss.org

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` | `addDetail()`
`Detail` | `getDetail()`
`String` | `getFaultActor()`
`String` | `getFaultCode()`
`Name` | `getFaultCodeAsName()`
`String` | `getFaultString()`
`Locale` | `getFaultStringLocale()`
`void` | `setFaultActor(String faultActor)`
`void` | `setFaultCode(Name faultCodeQName)`
`void` | `setFaultCode(String faultCode)`
`void` | `setFaultString(String faultString)`
`void` | `setFaultString(String faultString, Locale locale)`

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

### addDetail

    public Detail addDetail()
                     throws SOAPException

  Throws:
    `SOAPException`

### getDetail

    public Detail getDetail()

### getFaultActor

    public String getFaultActor()

### getFaultCode

    public String getFaultCode()

### getFaultCodeAsName

    public Name getFaultCodeAsName()

### getFaultString

    public String getFaultString()

### getFaultStringLocale

    public Locale getFaultStringLocale()

### setFaultActor

    public void setFaultActor(String faultActor)
                       throws SOAPException

  Throws:
    `SOAPException`

### setFaultCode

    public void setFaultCode(String faultCode)
                      throws SOAPException

  Throws:
    `SOAPException`

### setFaultCode

    public void setFaultCode(Name faultCodeQName)
                      throws SOAPException

  Throws:
    `SOAPException`

### setFaultString

    public void setFaultString(String faultString)
                        throws SOAPException

  Throws:
    `SOAPException`

### setFaultString

    public void setFaultString(String faultString,
                               Locale locale)
                        throws SOAPException

  Throws:
    `SOAPException`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002 JBoss Group, LLC. All Rights Reserved.