IRmElement


1   /*
2    * Copyright  1999-2004 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   */
17  
18  package org.apache.sandesha.ws.rm;
19  
20  import org.apache.axis.message.MessageElement;
21  
22  import javax.xml.soap.SOAPException  ;
23  
24  /**
25   * class IRmElement
26   *
27   * @author Amila Navarathna
28   * @author Jaliya Ekanayaka
29   * @author Sudar Nimalan <p/><p/>This is the parent interface for the
30   *         rm-protocol elements except the element who are in the format of a
31   *         URI <br>
32   *         <p/><b>If require to add the attributes, extend the concrete class
33   *         with MessageElement </b> <br>
34   *         <b>If require to add child elements, extend the concrete class with
35   *         MessageElement </b> <br>
36   */
37  public interface IRmElement {
38  
39      /**
40       * Methode getSoapElement
41       * <p/>
42       * This gives the soap element of the protocol element. Each implementation
43       * must implement this method such that then it can be easily get the
44       * related soap element
45       *
46       * @return the soap element
47       * @throws SOAPException
48       */
49      MessageElement getSoapElement() throws SOAPException  ;
50  
51      /**
52       * Method addChildElement Adds an element to this element as a child
53       * element. If not required to add a child element, just provide an empty
54       * implementation in the concrete class
55       *
56       * @param element the child element
57       * @throws SOAPException
58       */
59      void addChildElement(MessageElement element) throws SOAPException  ;
60  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags