/* | |
* 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 <CODE>SOAPHeader</CODE> object for this <CODE> | |
* SOAPEnvelope</CODE> object. | |
* <P> This SOAPHeader will just be a container for all the headers in the | |
* <CODE>OMMessage</CODE> | |
* </P> | |
* | |
* @return the <CODE>SOAPHeader</CODE> object or <CODE> | |
* null</CODE> if there is none | |
* @throws org.apache.axiom.om.OMException | |
* if there is a problem | |
* obtaining the <CODE>SOAPHeader</CODE> object | |
*/ | |
public abstract SOAPHeader getHeader() throws OMException; | |
/** | |
* Returns the <CODE>SOAPBody</CODE> object associated with | |
* this <CODE>SOAPEnvelope</CODE> object. | |
* <P> This SOAPBody will just be a container for all the BodyElements in the | |
* <CODE>OMMessage</CODE> | |
* </P> | |
* | |
* @return the <CODE>SOAPBody</CODE> object for this <CODE> | |
* SOAPEnvelope</CODE> object or <CODE>null</CODE> if there | |
* is none | |
* @throws OMException if there is a problem | |
* obtaining the <CODE>SOAPBody</CODE> object | |
*/ | |
public abstract SOAPBody getBody() throws OMException; | |
} |