ohair@286: /*
alanb@368:  * Copyright (c) 1997, 2012, 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.xml.internal.ws.api.model.wsdl.WSDLExtensible;
ohair@286: import com.sun.istack.internal.NotNull;
ohair@286: import com.sun.istack.internal.Nullable;
ohair@286: 
ohair@286: import javax.xml.namespace.QName;
ohair@286: 
ohair@286: /**
ohair@286:  * Provides abstraction of wsdl:portType/wsdl:operation.
ohair@286:  *
ohair@286:  * @author Vivek Pandey
ohair@286:  */
ohair@286: public interface WSDLOperation extends WSDLObject, WSDLExtensible {
ohair@286:     /**
ohair@286:      * Gets the name of the wsdl:portType/wsdl:operation@name attribute value as local name and wsdl:definitions@targetNamespace
ohair@286:      * as the namespace uri.
ohair@286:      */
ohair@286:     @NotNull QName getName();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the wsdl:input of this operation
ohair@286:      */
ohair@286:     @NotNull WSDLInput getInput();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the wsdl:output of this operation.
ohair@286:      *
ohair@286:      * @return
ohair@286:      *      null if this is an one-way operation.
ohair@286:      */
ohair@286:     @Nullable WSDLOutput getOutput();
ohair@286: 
ohair@286: 
ohair@286: 
ohair@286:     /**
ohair@286:      * Returns true if this operation is an one-way operation.
ohair@286:      */
ohair@286:     boolean isOneWay();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the {@link WSDLFault} corresponding to wsdl:fault of this operation.
ohair@286:      */
ohair@286:     Iterable<? extends WSDLFault> getFaults();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gives {@link WSDLFault} for the given soap fault detail value.
ohair@286:      *
ohair@286:      * <pre>
ohair@286:      *
ohair@286:      * Given a wsdl fault:
ohair@286:      *
ohair@286:      * &lt;wsdl:message nae="faultMessage">
ohair@286:      *  &lt;wsdl:part name="fault" element="<b>ns:myException</b>/>
ohair@286:      * &lt;/wsdl:message>
ohair@286:      *
ohair@286:      * &lt;wsdl:portType>
ohair@286:      *  &lt;wsdl:operation ...>
ohair@286:      *      &lt;wsdl:fault name="aFault" message="faultMessage"/>
ohair@286:      *  &lt;/wsdl:operation>
ohair@286:      * &lt;wsdl:portType>
ohair@286:      *
ohair@286:      *
ohair@286:      * For example given a soap 11 soap message:
ohair@286:      *
ohair@286:      * &lt;soapenv:Fault>
ohair@286:      *      ...
ohair@286:      *      &lt;soapenv:detail>
ohair@286:      *          &lt;<b>ns:myException</b>>
ohair@286:      *              ...
ohair@286:      *          &lt;/ns:myException>
ohair@286:      *      &lt;/soapenv:detail>
ohair@286:      *
ohair@286:      * QName faultQName = new QName(ns, "myException");
ohair@286:      * WSDLFault wsdlFault  = getFault(faultQName);
ohair@286:      *
ohair@286:      * The above call will return a WSDLFault that abstracts wsdl:portType/wsdl:operation/wsdl:fault.
ohair@286:      *
ohair@286:      * </pre>
ohair@286:      *
ohair@286:      * @param faultDetailName tag name of the element inside soaenv:Fault/detail/, must be non-null.
ohair@286:      * @return returns null if a wsdl fault corresponding to the detail entry name not found.
ohair@286:      */
ohair@286:     @Nullable WSDLFault getFault(QName faultDetailName);
ohair@286: 
ohair@286:     /**
ohair@286:      * Gives the enclosing wsdl:portType@name attribute value.
ohair@286:      */
ohair@286:     @NotNull QName getPortTypeName();
ohair@286: }