org.apache.axiom.soap.SOAPBody Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of axiom-api
The Axiom API
There is a newer version: 2.0.0
/*
 * Copyright 2004,2005 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.axiom.soap;

import org.apache.axiom.om.OMElement;
import org.apache.axiom.om.OMException;

/**
 * An object that represents the contents of the SOAP body element in a SOAP message. B SOAP body
 * element consists of XML data that affects the way the application-specific content is processed.
 * 
 * B SOAPBody object contains OMBodyBlock objects, which have the content
 * for the SOAP body. B SOAPFault object, which carries status and/or error
 * information, is an example of a OMBodyBlock object.
 */
public interface SOAPBody extends OMElement {
    /**
     * Creates a new SOAPFault object and adds it to this SOAPBody
     * object.
     *
     * @param e
     * @return the new SOAPFault object
     * @throws org.apache.axiom.om.OMException
     *          if there is a SOAP error
     * @throws org.apache.axiom.om.OMException
     *
     */
    SOAPFault addFault(Exception e) throws OMException;

    /**
     * Indicates whether a SOAPFault object exists in this SOAPBody
     * object.
     *
     * @return true if a SOAPFault object exists in this
     *         SOAPBody object; false otherwise
     */
    boolean hasFault();

    /**
     * Returns the SOAPFault object in this SOAPBody object.
     *
     * @return the SOAPFault object in this SOAPBody object
     */
    SOAPFault getFault();

    /**
     * @param soapFault
     * @throws OMException
     */
    void addFault(SOAPFault soapFault) throws OMException;


}