jakarta.xml.soap.Detail Maven / Gradle / Ivy
/*
* Copyright (c) 2004, 2022 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package jakarta.xml.soap;
import java.util.Iterator;
import javax.xml.namespace.QName;
/**
* A container for {@code DetailEntry} objects. {@code DetailEntry}
* objects give detailed error information that is application-specific and
* related to the {@code SOAPBody} object that contains it.
*
* A {@code Detail} object, which is part of a {@code SOAPFault}
* object, can be retrieved using the method {@code SOAPFault.getDetail}.
* The {@code Detail} interface provides two methods. One creates a new
* {@code DetailEntry} object and also automatically adds it to
* the {@code Detail} object. The second method gets a list of the
* {@code DetailEntry} objects contained in a {@code Detail}
* object.
*
* The following code fragment, in which sf is a {@code SOAPFault}
* object, gets its {@code Detail} object (d), adds a new
* {@code DetailEntry} object to d, and then gets a list of all the
* {@code DetailEntry} objects in d. The code also creates a
* {@code Name} object to pass to the method {@code addDetailEntry}.
* The variable se, used to create the {@code Name} object,
* is a {@code SOAPEnvelope} object.
*
{@code
* Detail d = sf.getDetail();
* Name name = se.createName("GetLastTradePrice", "WOMBAT",
* "http://www.wombat.org/trader");
* d.addDetailEntry(name);
* Iterator it = d.getDetailEntries();
* }
*
* @since 1.6
*/
public interface Detail extends SOAPFaultElement {
/**
* Creates a new {@code DetailEntry} object with the given
* name and adds it to this {@code Detail} object.
*
* @param name a {@code Name} object identifying the
* new {@code DetailEntry} object
*
* @return the new {@code DetailEntry} object that was
* created
*
* @exception SOAPException thrown when there is a problem in adding a
* DetailEntry object to this Detail object.
*
* @see Detail#addDetailEntry(QName qname)
*/
DetailEntry addDetailEntry(Name name) throws SOAPException;
/**
* Creates a new {@code DetailEntry} object with the given
* QName and adds it to this {@code Detail} object. This method
* is the preferred over the one using Name.
*
* @param qname a {@code QName} object identifying the
* new {@code DetailEntry} object
*
* @return the new {@code DetailEntry} object that was
* created
*
* @exception SOAPException thrown when there is a problem in adding a
* DetailEntry object to this Detail object.
*
* @see Detail#addDetailEntry(Name name)
* @since 1.6, SAAJ 1.3
*/
DetailEntry addDetailEntry(QName qname) throws SOAPException;
/**
* Gets an Iterator over all of the {@code DetailEntry}s in this {@code Detail} object.
*
* @return an {@code Iterator} object over the {@code DetailEntry}
* objects in this {@code Detail} object
*/
Iterator getDetailEntries();
}