View Javadoc
1   /*
2    * Copyright 2005-2010 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.springframework.ws.soap;
18  
19  import java.util.Iterator;
20  import javax.xml.namespace.QName;
21  import javax.xml.transform.Result;
22  
23  /**
24   * Represents the <code>detail</code> element in a SOAP fault. A detail contains <code>SoapFaultDetailElement</code>s,
25   * which represent the individual details.
26   *
27   * @author Arjen Poutsma
28   * @see SoapFaultDetailElement
29   * @since 1.0.0
30   */
31  public interface SoapFaultDetail extends SoapElement {
32  
33      /**
34       * Adds a new <code>SoapFaultDetailElement</code> with the specified qualified name to this detail.
35       *
36       * @param name the qualified name of the new detail element
37       * @return the created <code>SoapFaultDetailElement</code>
38       */
39      SoapFaultDetailElement addFaultDetailElement(QName name);
40  
41      /**
42       * Returns a <code>Result</code> that represents the concents of the detail.
43       * <p/>
44       * The result can be used for marshalling.
45       *
46       * @return the <code>Result</code> of this element
47       */
48      Result getResult();
49  
50      /**
51       * Gets an iterator over all of the <code>SoapFaultDetailElement</code>s in this detail.
52       *
53       * @return an iterator over all the <code>SoapFaultDetailElement</code>s
54       * @see SoapFaultDetailElement
55       */
56      Iterator<SoapFaultDetailElement> getDetailEntries();
57  
58  }