ohair@286: /*
alanb@368:  * Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package javax.xml.soap;
ohair@286: 
ohair@286: import java.util.Locale;
ohair@286: 
ohair@286: import org.w3c.dom.Document;
ohair@286: 
ohair@286: import javax.xml.namespace.QName;
ohair@286: 
ohair@286: /**
ohair@286:  * An object that represents the contents of the SOAP body
ohair@286:  * element in a SOAP message. A SOAP body element consists of XML data
ohair@286:  * that affects the way the application-specific content is processed.
ohair@286:  * <P>
ohair@286:  * A <code>SOAPBody</code> object contains <code>SOAPBodyElement</code>
ohair@286:  * objects, which have the content for the SOAP body.
ohair@286:  * A <code>SOAPFault</code> object, which carries status and/or
ohair@286:  * error information, is an example of a <code>SOAPBodyElement</code> object.
ohair@286:  *
ohair@286:  * @see SOAPFault
ohair@286:  */
ohair@286: public interface SOAPBody extends SOAPElement {
ohair@286: 
ohair@286:     /**
ohair@286:      * Creates a new <code>SOAPFault</code> object and adds it to
ohair@286:      * this <code>SOAPBody</code> object. The new <code>SOAPFault</code> will
ohair@286:      * have default values set for the mandatory child elements. The type of
ohair@286:      * the <code>SOAPFault</code> will be a SOAP 1.1 or a SOAP 1.2 <code>SOAPFault</code>
ohair@286:      * depending on the <code>protocol</code> specified while creating the
ohair@286:      * <code>MessageFactory</code> instance.
ohair@286:      * <p>
ohair@286:      * A <code>SOAPBody</code> may contain at most one <code>SOAPFault</code>
ohair@286:      * child element.
ohair@286:      *
ohair@286:      * @return the new <code>SOAPFault</code> object
ohair@286:      * @exception SOAPException if there is a SOAP error
ohair@286:      */
ohair@286:     public SOAPFault addFault() throws SOAPException;
ohair@286: 
ohair@286: 
ohair@286:     /**
ohair@286:      * Creates a new <code>SOAPFault</code> object and adds it to
ohair@286:      * this <code>SOAPBody</code> object. The type of the
ohair@286:      * <code>SOAPFault</code> will be a SOAP 1.1  or a SOAP 1.2
ohair@286:      * <code>SOAPFault</code> depending on the <code>protocol</code>
ohair@286:      * specified while creating the <code>MessageFactory</code> instance.
ohair@286:      * <p>
ohair@286:      * For SOAP 1.2 the <code>faultCode</code> parameter is the value of the
ohair@286:      * <i>Fault/Code/Value</i> element  and the <code>faultString</code> parameter
ohair@286:      * is the value of the <i>Fault/Reason/Text</i> element. For SOAP 1.1
ohair@286:      * the <code>faultCode</code> parameter is the value of the <code>faultcode</code>
ohair@286:      * element and the <code>faultString</code> parameter is the value of the <code>faultstring</code>
ohair@286:      * element.
ohair@286:      * <p>
ohair@286:      * A <code>SOAPBody</code> may contain at most one <code>SOAPFault</code>
ohair@286:      * child element.
ohair@286:      *
ohair@286:      * @param faultCode a <code>Name</code> object giving the fault
ohair@286:      *         code to be set; must be one of the fault codes defined in the Version
ohair@286:      *         of SOAP specification in use
ohair@286:      * @param faultString a <code>String</code> giving an explanation of
ohair@286:      *         the fault
ohair@286:      * @param locale a {@link java.util.Locale} object indicating
ohair@286:      *         the native language of the <code>faultString</code>
ohair@286:      * @return the new <code>SOAPFault</code> object
ohair@286:      * @exception SOAPException if there is a SOAP error
ohair@286:      * @see SOAPFault#setFaultCode
ohair@286:      * @see SOAPFault#setFaultString
ohair@286:      * @since SAAJ 1.2
ohair@286:      */
ohair@286:     public SOAPFault addFault(Name faultCode, String faultString, Locale locale) throws SOAPException;
ohair@286: 
ohair@286:     /**
ohair@286:      * Creates a new <code>SOAPFault</code> object and adds it to this
ohair@286:      * <code>SOAPBody</code> object. The type of the <code>SOAPFault</code>
ohair@286:      * will be a SOAP 1.1 or a SOAP 1.2 <code>SOAPFault</code> depending on
ohair@286:      * the <code>protocol</code> specified while creating the <code>MessageFactory</code>
ohair@286:      * instance.
ohair@286:      * <p>
ohair@286:      * For SOAP 1.2 the <code>faultCode</code> parameter is the value of the
ohair@286:      * <i>Fault/Code/Value</i> element  and the <code>faultString</code> parameter
ohair@286:      * is the value of the <i>Fault/Reason/Text</i> element. For SOAP 1.1
ohair@286:      * the <code>faultCode</code> parameter is the value of the <code>faultcode</code>
ohair@286:      * element and the <code>faultString</code> parameter is the value of the <code>faultstring</code>
ohair@286:      * element.
ohair@286:      * <p>
ohair@286:      * A <code>SOAPBody</code> may contain at most one <code>SOAPFault</code>
ohair@286:      * child element.
ohair@286:      *
ohair@286:      * @param faultCode
ohair@286:      *            a <code>QName</code> object giving the fault code to be
ohair@286:      *            set; must be one of the fault codes defined in the version
ohair@286:      *            of SOAP specification in use.
ohair@286:      * @param faultString
ohair@286:      *            a <code>String</code> giving an explanation of the fault
ohair@286:      * @param locale
ohair@286:      *            a {@link java.util.Locale Locale} object indicating the
ohair@286:      *            native language of the <code>faultString</code>
ohair@286:      * @return the new <code>SOAPFault</code> object
ohair@286:      * @exception SOAPException
ohair@286:      *                if there is a SOAP error
ohair@286:      * @see SOAPFault#setFaultCode
ohair@286:      * @see SOAPFault#setFaultString
ohair@286:      * @see SOAPBody#addFault(Name faultCode, String faultString, Locale locale)
ohair@286:      *
ohair@286:      * @since SAAJ 1.3
ohair@286:      */
ohair@286:     public SOAPFault addFault(QName faultCode, String faultString, Locale locale)
ohair@286:         throws SOAPException;
ohair@286: 
ohair@286:     /**
ohair@286:      * Creates a new  <code>SOAPFault</code> object and adds it to this
ohair@286:      * <code>SOAPBody</code> object. The type of the <code>SOAPFault</code>
ohair@286:      * will be a SOAP 1.1 or a SOAP 1.2 <code>SOAPFault</code> depending on
ohair@286:      * the <code>protocol</code> specified while creating the <code>MessageFactory</code>
ohair@286:      * instance.
ohair@286:      * <p>
ohair@286:      * For SOAP 1.2 the <code>faultCode</code> parameter is the value of the
ohair@286:      * <i>Fault/Code/Value</i> element  and the <code>faultString</code> parameter
ohair@286:      * is the value of the <i>Fault/Reason/Text</i> element. For SOAP 1.1
ohair@286:      * the <code>faultCode</code> parameter is the value of the <i>faultcode</i>
ohair@286:      * element and the <code>faultString</code> parameter is the value of the <i>faultstring</i>
ohair@286:      * element.
ohair@286:      * <p>
ohair@286:      * In case of a SOAP 1.2 fault, the default value for the mandatory <code>xml:lang</code>
ohair@286:      * attribute on the <i>Fault/Reason/Text</i> element will be set to
ohair@286:      * <code>java.util.Locale.getDefault()</code>
ohair@286:      * <p>
ohair@286:      * A <code>SOAPBody</code> may contain at most one <code>SOAPFault</code>
ohair@286:      * child element.
ohair@286:      *
ohair@286:      * @param faultCode
ohair@286:      *            a <code>Name</code> object giving the fault code to be set;
ohair@286:      *            must be one of the fault codes defined in the version of SOAP
ohair@286:      *            specification in use
ohair@286:      * @param faultString
ohair@286:      *            a <code>String</code> giving an explanation of the fault
ohair@286:      * @return the new <code>SOAPFault</code> object
ohair@286:      * @exception SOAPException
ohair@286:      *                if there is a SOAP error
ohair@286:      * @see SOAPFault#setFaultCode
ohair@286:      * @see SOAPFault#setFaultString
ohair@286:      * @since SAAJ 1.2
ohair@286:      */
ohair@286:     public SOAPFault addFault(Name faultCode, String faultString)
ohair@286:         throws SOAPException;
ohair@286: 
ohair@286:     /**
ohair@286:      * Creates a new <code>SOAPFault</code> object and adds it to this <code>SOAPBody</code>
ohair@286:      * object. The type of the <code>SOAPFault</code>
ohair@286:      * will be a SOAP 1.1 or a SOAP 1.2 <code>SOAPFault</code> depending on
ohair@286:      * the <code>protocol</code> specified while creating the <code>MessageFactory</code>
ohair@286:      * instance.
ohair@286:      * <p>
ohair@286:      * For SOAP 1.2 the <code>faultCode</code> parameter is the value of the
ohair@286:      * <i>Fault/Code/Value</i> element  and the <code>faultString</code> parameter
ohair@286:      * is the value of the <i>Fault/Reason/Text</i> element. For SOAP 1.1
ohair@286:      * the <code>faultCode</code> parameter is the value of the <i>faultcode</i>
ohair@286:      * element and the <code>faultString</code> parameter is the value of the <i>faultstring</i>
ohair@286:      * element.
ohair@286:      * <p>
ohair@286:      * In case of a SOAP 1.2 fault, the default value for the mandatory <code>xml:lang</code>
ohair@286:      * attribute on the <i>Fault/Reason/Text</i> element will be set to
ohair@286:      * <code>java.util.Locale.getDefault()</code>
ohair@286:      * <p>
ohair@286:      * A <code>SOAPBody</code> may contain at most one <code>SOAPFault</code>
ohair@286:      * child element
ohair@286:      *
ohair@286:      * @param faultCode
ohair@286:      *            a <code>QName</code> object giving the fault code to be
ohair@286:      *            set; must be one of the fault codes defined in the version
ohair@286:      *            of  SOAP specification in use
ohair@286:      * @param faultString
ohair@286:      *            a <code>String</code> giving an explanation of the fault
ohair@286:      * @return the new <code>SOAPFault</code> object
ohair@286:      * @exception SOAPException
ohair@286:      *                if there is a SOAP error
ohair@286:      * @see SOAPFault#setFaultCode
ohair@286:      * @see SOAPFault#setFaultString
ohair@286:      * @see SOAPBody#addFault(Name faultCode, String faultString)
ohair@286:      * @since SAAJ 1.3
ohair@286:      */
ohair@286:     public SOAPFault addFault(QName faultCode, String faultString)
ohair@286:         throws SOAPException;
ohair@286: 
ohair@286:     /**
ohair@286:      * Indicates whether a <code>SOAPFault</code> object exists in this
ohair@286:      * <code>SOAPBody</code> object.
ohair@286:      *
ohair@286:      * @return <code>true</code> if a <code>SOAPFault</code> object exists
ohair@286:      *         in this <code>SOAPBody</code> object; <code>false</code>
ohair@286:      *         otherwise
ohair@286:      */
ohair@286:     public boolean hasFault();
ohair@286: 
ohair@286:     /**
ohair@286:      * Returns the <code>SOAPFault</code> object in this <code>SOAPBody</code>
ohair@286:      * object.
ohair@286:      *
ohair@286:      * @return the <code>SOAPFault</code> object in this <code>SOAPBody</code>
ohair@286:      *         object if present, null otherwise.
ohair@286:      */
ohair@286:     public SOAPFault getFault();
ohair@286: 
ohair@286:     /**
ohair@286:      * Creates a new <code>SOAPBodyElement</code> object with the specified
ohair@286:      * name and adds it to this <code>SOAPBody</code> object.
ohair@286:      *
ohair@286:      * @param name
ohair@286:      *            a <code>Name</code> object with the name for the new <code>SOAPBodyElement</code>
ohair@286:      *            object
ohair@286:      * @return the new <code>SOAPBodyElement</code> object
ohair@286:      * @exception SOAPException
ohair@286:      *                if a SOAP error occurs
ohair@286:      * @see SOAPBody#addBodyElement(javax.xml.namespace.QName)
ohair@286:      */
ohair@286:     public SOAPBodyElement addBodyElement(Name name) throws SOAPException;
ohair@286: 
ohair@286: 
ohair@286:     /**
ohair@286:      * Creates a new <code>SOAPBodyElement</code> object with the specified
ohair@286:      * QName and adds it to this <code>SOAPBody</code> object.
ohair@286:      *
ohair@286:      * @param qname
ohair@286:      *            a <code>QName</code> object with the qname for the new
ohair@286:      *            <code>SOAPBodyElement</code> object
ohair@286:      * @return the new <code>SOAPBodyElement</code> object
ohair@286:      * @exception SOAPException
ohair@286:      *                if a SOAP error occurs
ohair@286:      * @see SOAPBody#addBodyElement(Name)
ohair@286:      * @since SAAJ 1.3
ohair@286:      */
ohair@286:     public SOAPBodyElement addBodyElement(QName qname) throws SOAPException;
ohair@286: 
ohair@286:     /**
ohair@286:      * Adds the root node of the DOM <code>{@link org.w3c.dom.Document}</code>
ohair@286:      * to this <code>SOAPBody</code> object.
ohair@286:      * <p>
ohair@286:      * Calling this method invalidates the <code>document</code> parameter.
ohair@286:      * The client application should discard all references to this <code>Document</code>
ohair@286:      * and its contents upon calling <code>addDocument</code>. The behavior
ohair@286:      * of an application that continues to use such references is undefined.
ohair@286:      *
ohair@286:      * @param document
ohair@286:      *            the <code>Document</code> object whose root node will be
ohair@286:      *            added to this <code>SOAPBody</code>.
ohair@286:      * @return the <code>SOAPBodyElement</code> that represents the root node
ohair@286:      *         that was added.
ohair@286:      * @exception SOAPException
ohair@286:      *                if the <code>Document</code> cannot be added
ohair@286:      * @since SAAJ 1.2
ohair@286:      */
ohair@286:     public SOAPBodyElement addDocument(org.w3c.dom.Document document)
ohair@286:         throws SOAPException;
ohair@286: 
ohair@286:     /**
ohair@286:      * Creates a new DOM <code>{@link org.w3c.dom.Document}</code> and sets
ohair@286:      * the first child of this <code>SOAPBody</code> as it's document
ohair@286:      * element. The child <code>SOAPElement</code> is removed as part of the
ohair@286:      * process.
ohair@286:      *
ohair@286:      * @return the <code>{@link org.w3c.dom.Document}</code> representation
ohair@286:      *         of the <code>SOAPBody</code> content.
ohair@286:      *
ohair@286:      * @exception SOAPException
ohair@286:      *                if there is not exactly one child <code>SOAPElement</code> of the <code>
ohair@286:      *              <code>SOAPBody</code>.
ohair@286:      *
ohair@286:      * @since SAAJ 1.3
ohair@286:      */
ohair@286:     public org.w3c.dom.Document extractContentAsDocument()
ohair@286:         throws SOAPException;
ohair@286: }