Top Description Methods
jakarta.xml.soap

public Interface Detail

extends SOAPFaultElement
Imports
java.util.Iterator, javax.xml.namespace.QName

A container for DetailEntry objects. DetailEntry objects give detailed error information that is application-specific and related to the SOAPBody object that contains it.

A Detail object, which is part of a SOAPFault object, can be retrieved using the method SOAPFault.getDetail. The Detail interface provides two methods. One creates a new DetailEntry object and also automatically adds it to the Detail object. The second method gets a list of the DetailEntry objects contained in a Detail object.

The following code fragment, in which sf is a SOAPFault object, gets its Detail object (d), adds a new DetailEntry object to d, and then gets a list of all the DetailEntry objects in d. The code also creates a Name object to pass to the method addDetailEntry. The variable se, used to create the Name object, is a SOAPEnvelope object.

Detail d = sf.getDetail();
    Name name = se.createName("GetLastTradePrice", "WOMBAT",
                                "http://www.wombat.org/trader");
    d.addDetailEntry(name);
    Iterator<DetailEntry> it = d.getDetailEntries();
 
Since
1.6

Method Summary

Modifier and TypeMethod and Description
public DetailEntry

Returns:

the new DetailEntry object that was created
addDetailEntry
(Name
a Name object identifying the new DetailEntry object
name
)

Creates a new DetailEntry object with the given name and adds it to this Detail object.

public DetailEntry

Returns:

the new DetailEntry object that was created
addDetailEntry
(QName
a QName object identifying the new DetailEntry object
qname
)

Creates a new DetailEntry object with the given QName and adds it to this Detail object.

public Iterator<DetailEntry>

Returns:

an Iterator object over the DetailEntry objects in this Detail object
getDetailEntries
()

Gets an Iterator over all of the DetailEntrys in this Detail object.

Method Detail

addDetailEntryback to summary
public DetailEntry addDetailEntry(Name name) throws SOAPException

Creates a new DetailEntry object with the given name and adds it to this Detail object.

Parameters
name:Name

a Name object identifying the new DetailEntry object

Returns:DetailEntry

the new DetailEntry object that was created

Exceptions
SOAPException:
thrown when there is a problem in adding a DetailEntry object to this Detail object.
See Also
Detail#addDetailEntry(QName qname)
addDetailEntryback to summary
public DetailEntry addDetailEntry(QName qname) throws SOAPException

Creates a new DetailEntry object with the given QName and adds it to this Detail object. This method is the preferred over the one using Name.

Parameters
qname:QName

a QName object identifying the new DetailEntry object

Returns:DetailEntry

the new DetailEntry object that was created

Exceptions
SOAPException:
thrown when there is a problem in adding a DetailEntry object to this Detail object.
Since
1.6, SAAJ 1.3
See Also
Detail#addDetailEntry(Name name)
getDetailEntriesback to summary
public Iterator<DetailEntry> getDetailEntries()

Gets an Iterator over all of the DetailEntrys in this Detail object.

Returns:Iterator<DetailEntry>

an Iterator object over the DetailEntry objects in this Detail object