/*
* 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 org.w3c.dom.Document;
import java.util.Locale;
/**
* An object that represents the contents of the SOAP body element in a SOAP message. A SOAP body
* element consists of XML data that affects the way the application-specific content is processed.
* <p/>
* A <code>SOAPBody</code> object contains <code>SOAPBodyElement</code> objects, which have the
* content for the SOAP body. A <code>SOAPFault</code> object, which carries status and/or error
* information, is an example of a <code>SOAPBodyElement</code> object.
*
* @see SOAPFault SOAPFault
*/
public interface SOAPBody extends SOAPElement {
/**
* Creates a new <code>SOAPFault</code> object and adds it to this <code>SOAPBody</code>
* object.
*
* @return the new <code>SOAPFault</code> object
* @throws SOAPException if there is a SOAP error
*/
public abstract SOAPFault addFault() throws SOAPException;
/**
* Indicates whether a <code>SOAPFault</code> object exists in this <code>SOAPBody</code>
* object.
*
* @return <code>true</code> if a <code>SOAPFault</code> object exists in this
* <code>SOAPBody</code> object; <code>false</code> otherwise
*/
public abstract boolean hasFault();
/**
* Returns the <code>SOAPFault</code> object in this <code>SOAPBody</code> object.
*
* @return the <code>SOAPFault</code> object in this <code>SOAPBody</code> object
*/
public abstract SOAPFault getFault();
/**
* Creates a new <code>SOAPBodyElement</code> object with the specified name and adds it to this
* <code>SOAPBody</code> object.
*
* @param name a <code>Name</code> object with the name for the new <code>SOAPBodyElement</code>
* object
* @return the new <code>SOAPBodyElement</code> object
* @throws SOAPException if a SOAP error occurs
*/
public abstract SOAPBodyElement addBodyElement(Name name)
throws SOAPException;
/**
* Creates a new <code>SOAPFault</code> object and adds it to this <code>SOAPBody</code> object.
* The new <code>SOAPFault</code> will have a <code>faultcode</code> element that is set to the
* <code>faultCode</code> parameter and a <code>faultstring</code> set to
* <code>faultstring</code> and localized to <code>locale</code>.
*
* @param faultCode a <code>Name</code> object giving the fault code to be set; must be one of
* the fault codes defined in the SOAP 1.1 specification and of type QName
* @param faultString a <code>String</code> giving an explanation of the fault
* @param locale a <code>Locale</code> object indicating the native language of the
* <ocde>faultString</code>
* @return the new <code>SOAPFault</code> object
* @throws SOAPException if there is a SOAP error
*/
public abstract SOAPFault addFault(Name faultCode,
String faultString,
Locale locale) throws SOAPException;
/**
* Creates a new <code>SOAPFault</code> object and adds it to this <code>SOAPBody</code> object.
* The new <code>SOAPFault</code> will have a <code>faultcode</code> element that is set to the
* <code>faultCode</code> parameter and a <code>faultstring</code> set to
* <code>faultstring</code>.
*
* @param faultCode a <code>Name</code> object giving the fault code to be set; must be one of
* the fault codes defined in the SOAP 1.1 specification and of type QName
* @param faultString a <code>String</code> giving an explanation of the fault
* @return the new <code>SOAPFault</code> object
* @throws SOAPException if there is a SOAP error
*/
public abstract SOAPFault addFault(Name faultCode, String faultString) throws SOAPException;
/**
* Adds the root node of the DOM <code>Document</code> to this <code>SOAPBody</code> object.
* <p/>
* Calling this method invalidates the <code>document</code> parameter. The client application
* should discard all references to this <code>Document</code> and its contents upon calling
* <code>addDocument</code>. The behavior of an application that continues to use such
* references is undefined.
*
* @param document the <code>Document</code> object whose root node will be added to this
* <code>SOAPBody</code>
* @return the <code>SOAPBodyElement</code> that represents the root node that was added
* @throws SOAPException if the <code>Document</code> cannot be added
*/
public abstract SOAPBodyElement addDocument(Document document) throws SOAPException;
public abstract SOAPBodyElement addBodyElement(javax.xml.namespace.QName qname)
throws SOAPException;
public abstract SOAPFault addFault(javax.xml.namespace.QName qname,
java.lang.String s)
throws SOAPException;
public abstract SOAPFault addFault(javax.xml.namespace.QName qname,
java.lang.String s,
java.util.Locale locale)
throws SOAPException;
public abstract org.w3c.dom.Document extractContentAsDocument()
throws SOAPException;
}