aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.ws.api.model.wsdl;
aoqi@0: 
aoqi@0: import com.sun.istack.internal.NotNull;
aoqi@0: import com.sun.istack.internal.Nullable;
aoqi@0: 
aoqi@0: import javax.xml.namespace.QName;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Abstraction of wsdl:portType/wsdl:operation/wsdl:input
aoqi@0:  *
aoqi@0:  * @author Vivek Pandey
aoqi@0:  */
aoqi@0: public interface WSDLInput extends WSDLObject, WSDLExtensible {
aoqi@0:     /**
aoqi@0:      * Gives the wsdl:portType/wsdl:operation/wsdl:input@name
aoqi@0:      */
aoqi@0:     String getName();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gives the WSDLMessage corresponding to wsdl:input@message
aoqi@0:      * <p/>
aoqi@0:      * This method should not be called before the entire WSDLModel is built. Basically after the WSDLModel is built
aoqi@0:      * all the references are resolve in a post processing phase. IOW, the WSDL extensions should
aoqi@0:      * not call this method.
aoqi@0:      *
aoqi@0:      * @return Always returns null when called from inside WSDL extensions.
aoqi@0:      */
aoqi@0:     WSDLMessage getMessage();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gives the Action Message Addressing Property value for
aoqi@0:      * {@link WSDLInput} message.
aoqi@0:      * <p/>
aoqi@0:      * This method provides the correct value irrespective of
aoqi@0:      * whether the Action is explicitly specified in the WSDL or
aoqi@0:      * implicitly derived using the rules defined in WS-Addressing.
aoqi@0:      *
aoqi@0:      * @return Action
aoqi@0:      */
aoqi@0:     String getAction();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gives the owning {@link WSDLOperation}
aoqi@0:      */
aoqi@0:     @NotNull
aoqi@0:     WSDLOperation getOperation();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gives qualified name of the wsdl:input 'name' attribute value. If there is no name, then it computes the name from:
aoqi@0:      *
aoqi@0:      * If the wsdl:operation is oneway:
aoqi@0:      *
aoqi@0:      * wsdl:operation@name value, which is local name of {@link WSDLOperation#getName()}
aoqi@0:      * <p/>
aoqi@0:      * otherwise
aoqi@0:      *
aoqi@0:      * wsdl:operation@name+"Request", which is local name of {@link WSDLOperation#getName()} + "Request"
aoqi@0:      * <p/>
aoqi@0:      *
aoqi@0:      * The namespace uri is determined from the enclosing wsdl:operation.
aoqi@0:      */
aoqi@0:     @NotNull
aoqi@0:     QName getQName();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Checks if the Action value is implicitly derived using the rules defined in WS-Addressing.
aoqi@0:      *
aoqi@0:      * @return true if the Action value is implicitly derived using the rules defined in WS-Addressing.
aoqi@0:      */
aoqi@0:     boolean isDefaultAction();
aoqi@0: }