Java Web Services in a Nutshell

Name

Detail

Synopsis

public interface Detail extends SOAPFaultElement {
// Public Instance Methods
    public abstract DetailEntry addDetailEntry( Name name) 
        throws SOAPException; 
    public abstract Iterator getDetailEntries(  ); 
}

Detail is a SOAPElement that supplies application-specific information relating to a SOAP fault. A SOAPFault element that reports an error while processing the body part of an earlier message must contain a Detail element. Conversely, a SOAPFault reporting an error in the header of the message must not contain this element. The Detail element, when present, contains one or more detail entries that are represented in the SAAJ API by the DetailEntry element and contain the useful information relating to the fault.

To create a Detail element, use the addDetail( ) method of the SOAPFault object within which it is to appear. Once you have a Detail object, you can add entries to it by calling its addDetailEntry( ) method. To examine the entries contained in a Detail object, use the getDetailEntries( ) method, which returns an Iterator in which each item is of type DetailEntry.

Passed To

javax.xml.rpc.soap.SOAPFaultException.SOAPFaultException( )

Returned By

javax.xml.rpc.soap.SOAPFaultException.getDetail( ), SOAPFactory.createDetail( ), SOAPFault.{addDetail( ), getDetail( )}