javax.xml.soap.Detail Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2004-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.xml.soap;
import java.util.Iterator;
import 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 it = d.getDetailEntries();
*
*/
public interface Detail extends SOAPFaultElement {
/**
* Creates a new DetailEntry object with the given
* name and adds it to this Detail object.
*
* @param name a Name object identifying the
* new DetailEntry object
*
* @exception SOAPException thrown when there is a problem in adding a
* DetailEntry object to this Detail object.
*
* @see Detail#addDetailEntry(QName qname)
*/
public DetailEntry addDetailEntry(Name name) 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.
*
* @param qname a QName object identifying the
* new DetailEntry object
*
* @exception SOAPException thrown when there is a problem in adding a
* DetailEntry object to this Detail object.
*
* @see Detail#addDetailEntry(Name name)
* @since SAAJ 1.3
*/
public DetailEntry addDetailEntry(QName qname) throws SOAPException;
/**
* Gets an Iterator over all of the DetailEntrys in this Detail object.
*
* @return an Iterator object over the DetailEntry
* objects in this Detail object
*/
public Iterator getDetailEntries();
}