axiom-api/src/main/java/org/apache/axiom/soap/SOAPModelBuilder.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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.OMXMLParserWrapper;

/**
 * SOAP specific extension to {@link OMXMLParserWrapper}.
 */
public interface SOAPModelBuilder extends OMXMLParserWrapper {
    /**
     * Get the SOAP envelope for the document processed by this builder. This is a convenience
     * method that has the same return value as {@link OMXMLParserWrapper#getDocumentElement()}
     * but a different return type.
     * 
     * @return the SOAP envelope
     */
    SOAPEnvelope getSOAPEnvelope();
    
    /**
     * Get the SOAP message being built by this builder. This is a convenience method that has the
     * same return value as {@link OMXMLParserWrapper#getDocument()} but a different return type.
     * 
     * @return the SOAP message
     */
    SOAPMessage getSOAPMessage();
}