src/share/jaxws_classes/javax/xml/soap/Detail.java

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 637
9c07ef4934dd
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

ohair@286 1 /*
alanb@368 2 * Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package javax.xml.soap;
ohair@286 27
ohair@286 28 import java.util.Iterator;
ohair@286 29
ohair@286 30 import javax.xml.namespace.QName;
ohair@286 31
ohair@286 32 /**
ohair@286 33 * A container for <code>DetailEntry</code> objects. <code>DetailEntry</code>
ohair@286 34 * objects give detailed error information that is application-specific and
ohair@286 35 * related to the <code>SOAPBody</code> object that contains it.
ohair@286 36 *<P>
ohair@286 37 * A <code>Detail</code> object, which is part of a <code>SOAPFault</code>
ohair@286 38 * object, can be retrieved using the method <code>SOAPFault.getDetail</code>.
ohair@286 39 * The <code>Detail</code> interface provides two methods. One creates a new
ohair@286 40 * <code>DetailEntry</code> object and also automatically adds it to
ohair@286 41 * the <code>Detail</code> object. The second method gets a list of the
ohair@286 42 * <code>DetailEntry</code> objects contained in a <code>Detail</code>
ohair@286 43 * object.
ohair@286 44 * <P>
ohair@286 45 * The following code fragment, in which <i>sf</i> is a <code>SOAPFault</code>
ohair@286 46 * object, gets its <code>Detail</code> object (<i>d</i>), adds a new
ohair@286 47 * <code>DetailEntry</code> object to <i>d</i>, and then gets a list of all the
ohair@286 48 * <code>DetailEntry</code> objects in <i>d</i>. The code also creates a
ohair@286 49 * <code>Name</code> object to pass to the method <code>addDetailEntry</code>.
ohair@286 50 * The variable <i>se</i>, used to create the <code>Name</code> object,
ohair@286 51 * is a <code>SOAPEnvelope</code> object.
ohair@286 52 * <PRE>
ohair@286 53 * Detail d = sf.getDetail();
ohair@286 54 * Name name = se.createName("GetLastTradePrice", "WOMBAT",
ohair@286 55 * "http://www.wombat.org/trader");
ohair@286 56 * d.addDetailEntry(name);
ohair@286 57 * Iterator it = d.getDetailEntries();
ohair@286 58 * </PRE>
ohair@286 59 */
ohair@286 60 public interface Detail extends SOAPFaultElement {
ohair@286 61
ohair@286 62 /**
ohair@286 63 * Creates a new <code>DetailEntry</code> object with the given
ohair@286 64 * name and adds it to this <code>Detail</code> object.
ohair@286 65 *
ohair@286 66 * @param name a <code>Name</code> object identifying the
ohair@286 67 * new <code>DetailEntry</code> object
ohair@286 68 *
ohair@286 69 * @exception SOAPException thrown when there is a problem in adding a
ohair@286 70 * DetailEntry object to this Detail object.
ohair@286 71 *
ohair@286 72 * @see Detail#addDetailEntry(QName qname)
ohair@286 73 */
ohair@286 74 public DetailEntry addDetailEntry(Name name) throws SOAPException;
ohair@286 75
ohair@286 76 /**
ohair@286 77 * Creates a new <code>DetailEntry</code> object with the given
ohair@286 78 * QName and adds it to this <code>Detail</code> object. This method
ohair@286 79 * is the preferred over the one using Name.
ohair@286 80 *
ohair@286 81 * @param qname a <code>QName</code> object identifying the
ohair@286 82 * new <code>DetailEntry</code> object
ohair@286 83 *
ohair@286 84 * @exception SOAPException thrown when there is a problem in adding a
ohair@286 85 * DetailEntry object to this Detail object.
ohair@286 86 *
ohair@286 87 * @see Detail#addDetailEntry(Name name)
ohair@286 88 * @since SAAJ 1.3
ohair@286 89 */
ohair@286 90 public DetailEntry addDetailEntry(QName qname) throws SOAPException;
ohair@286 91
ohair@286 92 /**
ohair@286 93 * Gets an Iterator over all of the <code>DetailEntry</code>s in this <code>Detail</code> object.
ohair@286 94 *
ohair@286 95 * @return an <code>Iterator</code> object over the <code>DetailEntry</code>
ohair@286 96 * objects in this <code>Detail</code> object
ohair@286 97 */
ohair@286 98 public Iterator getDetailEntries();
ohair@286 99 }

mercurial