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