1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
/*
* JBoss, Home of Professional Open Source
* Copyright 2005, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
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();
* @author Scott.Stark@jboss.org
* @version $Revision: 2897 $
*/
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
* @throws SOAPException thrown when there is a problem in adding a DetailEntry object to this Detail object.
*/
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
* @throws SOAPException thrown when there is a problem in adding a DetailEntry object to this Detail object.
* @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();
}
|
