1 /*
2 * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
51 * is a {@code SOAPEnvelope} object.
52 * <pre>{@code
53 * Detail d = sf.getDetail();
54 * Name name = se.createName("GetLastTradePrice", "WOMBAT",
55 * "http://www.wombat.org/trader");
56 * d.addDetailEntry(name);
57 * Iterator it = d.getDetailEntries();
58 * }</pre>
59 *
60 * @since 1.6
61 */
62 public interface Detail extends SOAPFaultElement {
63
64 /**
65 * Creates a new {@code DetailEntry} object with the given
66 * name and adds it to this {@code Detail} object.
67 *
68 * @param name a {@code Name} object identifying the
69 * new {@code DetailEntry} object
70 *
71 * @exception SOAPException thrown when there is a problem in adding a
72 * DetailEntry object to this Detail object.
73 *
74 * @see Detail#addDetailEntry(QName qname)
75 */
76 public DetailEntry addDetailEntry(Name name) throws SOAPException;
77
78 /**
79 * Creates a new {@code DetailEntry} object with the given
80 * QName and adds it to this {@code Detail} object. This method
81 * is the preferred over the one using Name.
82 *
83 * @param qname a {@code QName} object identifying the
84 * new {@code DetailEntry} object
85 *
86 * @exception SOAPException thrown when there is a problem in adding a
87 * DetailEntry object to this Detail object.
88 *
89 * @see Detail#addDetailEntry(Name name)
90 * @since 1.6, SAAJ 1.3
91 */
92 public DetailEntry addDetailEntry(QName qname) throws SOAPException;
93
94 /**
95 * Gets an Iterator over all of the {@code DetailEntry}s in this {@code Detail} object.
96 *
97 * @return an {@code Iterator} object over the {@code DetailEntry}
98 * objects in this {@code Detail} object
99 */
100 public Iterator getDetailEntries();
101 }
|
1 /*
2 * Copyright (c) 2004, 2017, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
51 * is a {@code SOAPEnvelope} object.
52 * <pre>{@code
53 * Detail d = sf.getDetail();
54 * Name name = se.createName("GetLastTradePrice", "WOMBAT",
55 * "http://www.wombat.org/trader");
56 * d.addDetailEntry(name);
57 * Iterator it = d.getDetailEntries();
58 * }</pre>
59 *
60 * @since 1.6
61 */
62 public interface Detail extends SOAPFaultElement {
63
64 /**
65 * Creates a new {@code DetailEntry} object with the given
66 * name and adds it to this {@code Detail} object.
67 *
68 * @param name a {@code Name} object identifying the
69 * new {@code DetailEntry} object
70 *
71 * @return the new {@code DetailEntry} object that was
72 * created
73 *
74 * @exception SOAPException thrown when there is a problem in adding a
75 * DetailEntry object to this Detail object.
76 *
77 * @see Detail#addDetailEntry(QName qname)
78 */
79 public DetailEntry addDetailEntry(Name name) throws SOAPException;
80
81 /**
82 * Creates a new {@code DetailEntry} object with the given
83 * QName and adds it to this {@code Detail} object. This method
84 * is the preferred over the one using Name.
85 *
86 * @param qname a {@code QName} object identifying the
87 * new {@code DetailEntry} object
88 *
89 * @return the new {@code DetailEntry} object that was
90 * created
91 *
92 * @exception SOAPException thrown when there is a problem in adding a
93 * DetailEntry object to this Detail object.
94 *
95 * @see Detail#addDetailEntry(Name name)
96 * @since 1.6, SAAJ 1.3
97 */
98 public DetailEntry addDetailEntry(QName qname) throws SOAPException;
99
100 /**
101 * Gets an Iterator over all of the {@code DetailEntry}s in this {@code Detail} object.
102 *
103 * @return an {@code Iterator} object over the {@code DetailEntry}
104 * objects in this {@code Detail} object
105 */
106 public Iterator<DetailEntry> getDetailEntries();
107 }
|