Axis 2 example source code file (Detail.java)

This example Axis 2 source code file (Detail.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Axis 2 tags/keywords

detail, detail, detailentry, detailentry, iterator, soapexception, soapexception, soapfaultelement, soapfaultelement, util

The Axis 2 Detail.java source code

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package javax.xml.soap;

import javax.xml.namespace.QName;
import java.util.Iterator;

/**
 * A container for <code>DetailEntry objects. DetailEntry objects give detailed
 * error information that is application-specific and related to the <code>SOAPBody object
 * that contains it.
 * <p/>
 * A <code>Detail object, which is part of a SOAPFault object, can be retrieved
 * using the method <code>SOAPFault.getDetail. The 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 DetailEntry objects
 * contained in a <code>Detail object.
 * <p/>
 * The following code fragment, in which <i>sf is a SOAPFault object, gets its
 * <code>Detail object (d), adds a new 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 addDetailEntry. The
 * variable <i>se, used to create the Name object, is a SOAPEnvelope
 * object. <PRE> Detail d = sf.getDetail(); Name name = se.createName("GetLastTradePrice", "WOMBAT",
 * "http://www.wombat.org/trader"); d.addDetailEntry(name); Iterator it = d.getDetailEntries();
 * </PRE>
 */
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 DetailEntry object
     * @return DetailEntry.
     * @throws SOAPException thrown when there is a problem in adding a DetailEntry object to this
     *                       Detail object.
     */
    public abstract DetailEntry addDetailEntry(Name name) throws SOAPException;

    /**
     * Gets a list of the detail entries in this <code>Detail object.
     *
     * @return an <code>Iterator object over the DetailEntry objects in this
     *         <code>Detail object
     */
    public abstract Iterator getDetailEntries();

    public abstract DetailEntry addDetailEntry(QName qname)
            throws SOAPException;
}