< prev index next >

src/java.xml.ws/share/classes/javax/xml/soap/Detail.java

Print this page




  37  * A {@code Detail} object, which is part of a {@code SOAPFault}
  38  * object, can be retrieved using the method {@code SOAPFault.getDetail}.
  39  * The {@code Detail} interface provides two methods. One creates a new
  40  * {@code DetailEntry} object and also automatically adds it to
  41  * the {@code Detail} object. The second method gets a list of the
  42  * {@code DetailEntry} objects contained in a {@code Detail}
  43  * object.
  44  * <P>
  45  * The following code fragment, in which <i>sf</i> is a {@code SOAPFault}
  46  * object, gets its {@code Detail} object (<i>d</i>), adds a new
  47  * {@code DetailEntry} object to <i>d</i>, and then gets a list of all the
  48  * {@code DetailEntry} objects in <i>d</i>. The code also creates a
  49  * {@code Name} object to pass to the method {@code addDetailEntry}.
  50  * The variable <i>se</i>, used to create the {@code Name} object,
  51  * is a {@code SOAPEnvelope} object.
  52  * <pre>{@code
  53  *    Detail d = sf.getDetail();
  54  *    Name name = se.createName("GetLastTradePrice", "WOMBAT",
  55  *                                "http://www.wombat.org/trader");
  56  *    d.addDetailEntry(name);
  57  *    Iterator it = d.getDetailEntries();
  58  * }</pre>
  59  *
  60  * @since 1.6
  61  */
  62 public interface Detail extends SOAPFaultElement {
  63 
  64     /**
  65      * Creates a new {@code DetailEntry} object with the given
  66      * name and adds it to this {@code Detail} object.
  67      *
  68      * @param name a {@code Name} object identifying the
  69      *         new {@code DetailEntry} object
  70      *
  71      * @return the new {@code DetailEntry} object that was
  72      *         created
  73      *
  74      * @exception SOAPException thrown when there is a problem in adding a
  75      * DetailEntry object to this Detail object.
  76      *
  77      * @see Detail#addDetailEntry(QName qname)




  37  * A {@code Detail} object, which is part of a {@code SOAPFault}
  38  * object, can be retrieved using the method {@code SOAPFault.getDetail}.
  39  * The {@code Detail} interface provides two methods. One creates a new
  40  * {@code DetailEntry} object and also automatically adds it to
  41  * the {@code Detail} object. The second method gets a list of the
  42  * {@code DetailEntry} objects contained in a {@code Detail}
  43  * object.
  44  * <P>
  45  * The following code fragment, in which <i>sf</i> is a {@code SOAPFault}
  46  * object, gets its {@code Detail} object (<i>d</i>), adds a new
  47  * {@code DetailEntry} object to <i>d</i>, and then gets a list of all the
  48  * {@code DetailEntry} objects in <i>d</i>. The code also creates a
  49  * {@code Name} object to pass to the method {@code addDetailEntry}.
  50  * The variable <i>se</i>, used to create the {@code Name} object,
  51  * is a {@code SOAPEnvelope} object.
  52  * <pre>{@code
  53  *    Detail d = sf.getDetail();
  54  *    Name name = se.createName("GetLastTradePrice", "WOMBAT",
  55  *                                "http://www.wombat.org/trader");
  56  *    d.addDetailEntry(name);
  57  *    Iterator<DetailEntry> it = d.getDetailEntries();
  58  * }</pre>
  59  *
  60  * @since 1.6
  61  */
  62 public interface Detail extends SOAPFaultElement {
  63 
  64     /**
  65      * Creates a new {@code DetailEntry} object with the given
  66      * name and adds it to this {@code Detail} object.
  67      *
  68      * @param name a {@code Name} object identifying the
  69      *         new {@code DetailEntry} object
  70      *
  71      * @return the new {@code DetailEntry} object that was
  72      *         created
  73      *
  74      * @exception SOAPException thrown when there is a problem in adding a
  75      * DetailEntry object to this Detail object.
  76      *
  77      * @see Detail#addDetailEntry(QName qname)


< prev index next >