KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > axis2 > soap > SOAPEnvelope


1 /*
2  * Copyright 2004,2005 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.axis2.soap;
17
18 import org.apache.axis2.om.OMElement;
19 import org.apache.axis2.om.OMException;
20
21 /**
22  * Interface SOAPEnvelope
23  */
24 public interface SOAPEnvelope extends OMElement {
25     /**
26      * Returns the <CODE>SOAPHeader</CODE> object for this <CODE>
27      * SOAPEnvelope</CODE> object.
28      * <P> This SOAPHeader will just be a container for all the headers in the
29      * <CODE>OMMessage</CODE>
30      * </P>
31      *
32      * @return the <CODE>SOAPHeader</CODE> object or <CODE>
33      * null</CODE> if there is none
34      * @throws org.apache.axis2.om.OMException if there is a problem
35      * obtaining the <CODE>SOAPHeader</CODE> object
36      */
37     public abstract SOAPHeader getHeader() throws OMException;
38
39     /**
40      * Returns the <CODE>SOAPBody</CODE> object associated with
41      * this <CODE>SOAPEnvelope</CODE> object.
42      * <P> This SOAPBody will just be a container for all the BodyElements in the
43      * <CODE>OMMessage</CODE>
44      * </P>
45      *
46      * @return the <CODE>SOAPBody</CODE> object for this <CODE>
47      * SOAPEnvelope</CODE> object or <CODE>null</CODE> if there
48      * is none
49      * @throws OMException if there is a problem
50      * obtaining the <CODE>SOAPBody</CODE> object
51      */
52     public abstract SOAPBody getBody() throws OMException;
53 }
54
Popular Tags