1 /*
   2  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.xml.internal.ws.api.model.wsdl;
  27 
  28 import com.sun.istack.internal.NotNull;
  29 
  30 import javax.xml.namespace.QName;
  31 
  32 /**
  33  * Abstracts wsdl:portType/wsdl:operation/wsdl:fault
  34  *
  35  * @author Vivek Pandey
  36  */
  37 public interface WSDLFault extends WSDLObject, WSDLExtensible {
  38     /**
  39      * Gives wsdl:fault@name value
  40      */
  41     String getName();
  42 
  43     /**
  44      * Gives the WSDLMessage corresponding to wsdl:fault@message
  45      * This method should not be called before the entire WSDLModel is built. Basically after the WSDLModel is built
  46      * all the references are resolve in a post processing phase. IOW, the WSDL extensions should
  47      * not call this method.
  48      *
  49      * @return Always returns null when called from inside WSDL extensions.
  50      */
  51     WSDLMessage getMessage();
  52 
  53     /**
  54      * Gives the owning {@link WSDLOperation}
  55      */
  56     @NotNull
  57     WSDLOperation getOperation();
  58 
  59     /**
  60      * Gives qualified name of the wsdl:fault 'name' attribute value.
  61      * <p/>
  62      *
  63      * The namespace uri is determined from the enclosing wsdl:operation.
  64      */
  65     @NotNull
  66     QName getQName();
  67 
  68     /**
  69      * Gives the Action Message Addressing Property value for
  70      * {@link WSDLFault} message.
  71      * <p/>
  72      * This method provides the correct value irrespective of
  73      * whether the Action is explicitly specified in the WSDL or
  74      * implicitly derived using the rules defined in WS-Addressing.
  75      *
  76      * @return Action
  77      */
  78     String getAction();
  79 }