org.apache.axiom.soap.SOAPEnvelope 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: 1.4.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;

/**
 * Interface SOAPEnvelope
 */
public interface SOAPEnvelope extends OMElement {
    /**
     * Returns the SOAPHeader object for this 
     * SOAPEnvelope object.
     *  This SOAPHeader will just be a container for all the headers in the
     * OMMessage
     * 
     *
     * @return the SOAPHeader object or 
     *         null if there is none
     * @throws org.apache.axiom.om.OMException
     *          if there is a problem
     *          obtaining the SOAPHeader object
     */
    public abstract SOAPHeader getHeader() throws OMException;

    /**
     * Returns the SOAPBody object associated with
     * this SOAPEnvelope object.
     *  This SOAPBody will just be a container for all the BodyElements in the
     * OMMessage
     * 
     *
     * @return the SOAPBody object for this 
     *         SOAPEnvelope object or null if there
     *         is none
     * @throws OMException if there is a problem
     *                     obtaining the SOAPBody object
     */
    public abstract SOAPBody getBody() throws OMException;
}