org.apache.xmlbeans.impl.soap.SOAPBody Maven / Gradle / Ivy
Show all versions of com.liferay.dynamic.data.lists.service
/* Copyright 2004 The Apache Software Foundation * * Licensed 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 org.apache.xmlbeans.impl.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. *
* @return the new* A
SOAPBody
object containsSOAPBodyElement
* objects, which have the content for the SOAP body. * ASOAPFault
object, which carries status and/or * error information, is an example of aSOAPBodyElement
object. * @see SOAPFault SOAPFault */ public interface SOAPBody extends SOAPElement { /** * Creates a newSOAPFault
object and adds it to * thisSOAPBody
object. * @return the newSOAPFault
object * @throws SOAPException if there is a SOAP error */ public abstract SOAPFault addFault() throws SOAPException; /** * Indicates whether aSOAPFault
object exists in * thisSOAPBody
object. * @returntrue
if aSOAPFault
object exists in * thisSOAPBody
object;false
* otherwise */ public abstract boolean hasFault(); /** * Returns theSOAPFault
object in thisSOAPBody
* object. * @return theSOAPFault
object in thisSOAPBody
* object */ public abstract SOAPFault getFault(); /** * Creates a newSOAPBodyElement
object with the * specified name and adds it to thisSOAPBody
object. * @param name aName
object with the name for the new *SOAPBodyElement
object * @return the newSOAPBodyElement
object * @throws SOAPException if a SOAP error occurs */ public abstract SOAPBodyElement addBodyElement(Name name) throws SOAPException; /** * Creates a newSOAPFault
object and adds it to this *SOAPBody
object. The newSOAPFault
will have a *faultcode
element that is set to thefaultCode
* parameter and afaultstring
set tofaultstring
* and localized tolocale
. * * @param faultCode aName
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 aString
giving an explanation of the * fault * @param locale aLocale
object indicating the native language * of thefaultString SOAPFault
object * @throws SOAPException if there is a SOAP error */ public abstract SOAPFault addFault(Name faultCode, String faultString, Locale locale) throws SOAPException; /** * Creates a newSOAPFault
object and adds it to this *SOAPBody
object. The newSOAPFault
will have a *faultcode
element that is set to thefaultCode
* parameter and afaultstring
set tofaultstring
. * * @param faultCode aName
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 aString
giving an explanation of the * fault * @return the newSOAPFault
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 DOMDocument
to this *SOAPBody
object. ** Calling this method invalidates the
document
parameter. The * client application should discard all references to this *Document
and its contents upon calling *addDocument
. The behavior of an application that continues * to use such references is undefined. * * @param document theDocument
object whose root node will be * added to thisSOAPBody
* @return theSOAPBodyElement
that represents the root node * that was added * @throws SOAPException if theDocument
cannot be added */ public abstract SOAPBodyElement addDocument(Document document) throws SOAPException; }