ohair@286: /*
alanb@368:  * Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package javax.xml.soap;
ohair@286: 
ohair@286: import java.util.Iterator;
ohair@286: 
ohair@286: import javax.xml.namespace.QName;
ohair@286: 
ohair@286: /**
ohair@286:  * A container for <code>DetailEntry</code> objects. <code>DetailEntry</code>
ohair@286:  * objects give detailed error information that is application-specific and
ohair@286:  * related to the <code>SOAPBody</code> object that contains it.
ohair@286:  *<P>
ohair@286:  * A <code>Detail</code> object, which is part of a <code>SOAPFault</code>
ohair@286:  * object, can be retrieved using the method <code>SOAPFault.getDetail</code>.
ohair@286:  * The <code>Detail</code> interface provides two methods. One creates a new
ohair@286:  * <code>DetailEntry</code> object and also automatically adds it to
ohair@286:  * the <code>Detail</code> object. The second method gets a list of the
ohair@286:  * <code>DetailEntry</code> objects contained in a <code>Detail</code>
ohair@286:  * object.
ohair@286:  * <P>
ohair@286:  * The following code fragment, in which <i>sf</i> is a <code>SOAPFault</code>
ohair@286:  * object, gets its <code>Detail</code> object (<i>d</i>), adds a new
ohair@286:  * <code>DetailEntry</code> object to <i>d</i>, and then gets a list of all the
ohair@286:  * <code>DetailEntry</code> objects in <i>d</i>. The code also creates a
ohair@286:  * <code>Name</code> object to pass to the method <code>addDetailEntry</code>.
ohair@286:  * The variable <i>se</i>, used to create the <code>Name</code> object,
ohair@286:  * is a <code>SOAPEnvelope</code> object.
ohair@286:  * <PRE>
ohair@286:  *    Detail d = sf.getDetail();
ohair@286:  *    Name name = se.createName("GetLastTradePrice", "WOMBAT",
ohair@286:  *                                "http://www.wombat.org/trader");
ohair@286:  *    d.addDetailEntry(name);
ohair@286:  *    Iterator it = d.getDetailEntries();
ohair@286:  * </PRE>
ohair@286:  */
ohair@286: public interface Detail extends SOAPFaultElement {
ohair@286: 
ohair@286:     /**
ohair@286:      * Creates a new <code>DetailEntry</code> object with the given
ohair@286:      * name and adds it to this <code>Detail</code> object.
ohair@286:      *
ohair@286:      * @param name a <code>Name</code> object identifying the
ohair@286:      *         new <code>DetailEntry</code> object
ohair@286:      *
ohair@286:      * @exception SOAPException thrown when there is a problem in adding a
ohair@286:      * DetailEntry object to this Detail object.
ohair@286:      *
ohair@286:      * @see Detail#addDetailEntry(QName qname)
ohair@286:      */
ohair@286:     public DetailEntry addDetailEntry(Name name) throws SOAPException;
ohair@286: 
ohair@286:     /**
ohair@286:      * Creates a new <code>DetailEntry</code> object with the given
ohair@286:      * QName and adds it to this <code>Detail</code> object. This method
ohair@286:      * is the preferred over the one using Name.
ohair@286:      *
ohair@286:      * @param qname a <code>QName</code> object identifying the
ohair@286:      *         new <code>DetailEntry</code> object
ohair@286:      *
ohair@286:      * @exception SOAPException thrown when there is a problem in adding a
ohair@286:      * DetailEntry object to this Detail object.
ohair@286:      *
ohair@286:      * @see Detail#addDetailEntry(Name name)
ohair@286:      * @since SAAJ 1.3
ohair@286:      */
ohair@286:     public DetailEntry addDetailEntry(QName qname) throws SOAPException;
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets an Iterator over all of the <code>DetailEntry</code>s in this <code>Detail</code> object.
ohair@286:      *
ohair@286:      * @return an <code>Iterator</code> object over the <code>DetailEntry</code>
ohair@286:      *             objects in this <code>Detail</code> object
ohair@286:      */
ohair@286:     public Iterator getDetailEntries();
ohair@286: }