org.apache.woden.wsdl20.xml

## Interface InterfaceElement

- All Superinterfaces:
    AttributeExtensible, DocumentableElement, ElementExtensible, NestedElement, WSDLElement

      public interface InterfaceElement
      extends DocumentableElement, NestedElement

  Represents the WSDL 2.0 <interface> element.
  Author:
    John Kaputin (jkaputin@apache.org)

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addExtendedInterfaceName(QName interfaceName)` Add the named InterfaceElement to the set of InterfaceElements that this InterfaceElement extends.
    `InterfaceFaultElement` | `addInterfaceFaultElement()` Create an InterfaceFaultElement with this InterfaceElement as its parent and return a reference to it.
    `InterfaceOperationElement` | `addInterfaceOperationElement()` Create an InterfaceOperationElement with this InterfaceElement as its parent and return a reference to it.
    `void` | `addStyleDefaultURI(URI style)` Add the specified URI to the set of default operation style URIs.
    `InterfaceElement` | `getExtendedInterfaceElement(QName interfaceName)` Return the named InterfaceElement from the set of IntefaceElements extended by this InterfaceElement.
    `InterfaceElement[]` | `getExtendedInterfaceElements()` Return the set of InterfaceElements extended by this InterfaceElement.
    `QName[]` | `getExtendedInterfaceNames()` Return the qualified names of the InterfaceElements that this InterfaceElement extends.
    `InterfaceFaultElement` | `getInterfaceFaultElement(QName faultName)` Return the named InterfaceFaultElement from the set of InterfaceFaultElements defined directly within this InterfaceElement.
    `InterfaceFaultElement[]` | `getInterfaceFaultElements()` Return the set of InterfaceFaultElements defined directly within this InterfaceElement.
    `InterfaceOperationElement` | `getInterfaceOperationElement(QName operName)` Return the named InterfaceOperationElement from the set of InterfaceOperationElements defined directly within this InterfaceElement.
    `InterfaceOperationElement[]` | `getInterfaceOperationElements()` Return the set of InterfaceOperationElements defined directly within this InterfaceElement.
    `QName` | `getName()` Return the qualified name of this InterfaceElement, which consists of its local name and the targetNamespace of the parent DescriptionElement.
    `URI[]` | `getStyleDefault()` Return the set of URIs representing the default operation style.
    `void` | `removeExtendedInterfaceName(QName interfaceName)` Remove the named InterfaceElement from the set of InterfaceElements that this InterfaceElement extends.
    `void` | `setName(NCName name)` Set the name of this InterfaceElement to the specified NCName.

    - ### Methods inherited from interface org.apache.woden.wsdl20.xml.DocumentableElement

      `addDocumentationElement, getDocumentationElements`

    - ### Methods inherited from interface org.apache.woden.wsdl20.xml.NestedElement

      `getParentElement`

    - ### Methods inherited from interface org.apache.woden.wsdl20.xml.WSDLElement

      `addNamespace, getDeclaredNamespaces, getInScopeNamespaces, getNamespacePrefix, getNamespaceURI, removeNamespace`

    - ### Methods inherited from interface org.apache.woden.wsdl20.extensions.AttributeExtensible

      `getExtensionAttribute, getExtensionAttributes, getExtensionAttributesForNamespace, hasExtensionAttributesForNamespace, setExtensionAttribute`

    - ### Methods inherited from interface org.apache.woden.wsdl20.extensions.ElementExtensible

      `addExtensionElement, getExtensionElements, getExtensionElementsOfType, hasExtensionElementsForNamespace, removeExtensionElement`

- - ### Method Detail

    - #### setName

          void setName(NCName name)

      Set the name of this InterfaceElement to the specified NCName. This corresponds to the `name` attribute of the <interface> element.
      Parameters:
        `name` - the NCName that represents the local name of this interface

    - #### getName

          QName getName()

      Return the qualified name of this InterfaceElement, which consists of its local name and the targetNamespace of the parent DescriptionElement.
      Returns:
        the interface QName

    - #### addExtendedInterfaceName

          void addExtendedInterfaceName(QName interfaceName)

      Add the named InterfaceElement to the set of InterfaceElements that this InterfaceElement extends. This equates to adding a QName to the `extends` attribute of the <interface> element. If a null interface name is specified, no action is performed.
      Parameters:
        `interfaceName` - the QName of an extended interface

    - #### removeExtendedInterfaceName

          void removeExtendedInterfaceName(QName interfaceName)

      Remove the named InterfaceElement from the set of InterfaceElements that this InterfaceElement extends. This equates to removing a QName from the `extends` attribute of the <interface> element. If the named InterfaceElement is not extended by this InterfaceElement or if a null interface name is specified, no action is performed.
      Parameters:
        `interfaceName` - the QName of an extended interface

    - #### getExtendedInterfaceNames

          QName[] getExtendedInterfaceNames()

      Return the qualified names of the InterfaceElements that this InterfaceElement extends. This equates to the set of QNames defined in the `extends` attribute of the <interface> element. If no extended interfaces exist, an empty array is returned.
      Returns:
        an array of QName

    - #### getExtendedInterfaceElement

          InterfaceElement getExtendedInterfaceElement(QName interfaceName)

      Return the named InterfaceElement from the set of IntefaceElements extended by this InterfaceElement. The specified QName should equate to a QName defined in the `extends` attribute of the <interface> element. If the named InterfaceElement is not extended by this InterfaceElement or if a null interface name is specified, this method will return null.
      Parameters:
        `interfaceName` - the QName of an extended interface
      Returns:
        the named InterfaceElement

    - #### getExtendedInterfaceElements

          InterfaceElement[] getExtendedInterfaceElements()

      Return the set of InterfaceElements extended by this InterfaceElement. This equates to the set of QNames defined in the `extends` attribute of the <interface> element. If no extended interfaces exist, an empty array is returned.
      Returns:
        an array of InterfaceElement

    - #### addStyleDefaultURI

          void addStyleDefaultURI(URI style)

      Add the specified URI to the set of default operation style URIs. This equates to adding a URI to the `styleDefault` attribute of the <interface> element. If a null style URI is specified, no action is performed.
      Parameters:
        `style` - a URI representing an operation style

    - #### getStyleDefault

          URI[] getStyleDefault()

      Return the set of URIs representing the default operation style. This equates to the URIs defined in the `styleDefault` attribute of the <interface> element. If no style default URIs exist, an empty array is returned.
      Returns:
        an array of URI representing the default operation style

    - #### addInterfaceFaultElement

          InterfaceFaultElement addInterfaceFaultElement()

      Create an InterfaceFaultElement with this InterfaceElement as its parent and return a reference to it. This equates to adding a <fault> element to the <interface> element.
      Returns:
        the InterfaceFaultElement

    - #### getInterfaceFaultElement

          InterfaceFaultElement getInterfaceFaultElement(QName faultName)

      Return the named InterfaceFaultElement from the set of InterfaceFaultElements defined directly within this InterfaceElement. This equates to a named <fault> element declared within the <interface> element. This set does not include faults derived from extended interfaces. If the named InterfaceFaultElement does not exist or if a null value is specified, this method will return null.
      Parameters:
        `faultName` - the QName of the required InterfaceFaultElement
      Returns:
        the named InterfaceFaultElement

    - #### getInterfaceFaultElements

          InterfaceFaultElement[] getInterfaceFaultElements()

      Return the set of InterfaceFaultElements defined directly within this InterfaceElement. This equates to the set of <fault> elements declared within this <interface> element. This set does not include faults derived from extended interfaces. If no InterfaceFaultElements exist, an empty array is returned.
      Returns:
        array of InterfaceFaultElement

    - #### addInterfaceOperationElement

          InterfaceOperationElement addInterfaceOperationElement()

      Create an InterfaceOperationElement with this InterfaceElement as its parent and return a reference to it. This equates to adding an <operation> element to the <interface> element. If no InterfaceOperationElements exist, an empty array is returned.
      Returns:
        the InterfaceOperationElement

    - #### getInterfaceOperationElement

          InterfaceOperationElement getInterfaceOperationElement(QName operName)

      Return the named InterfaceOperationElement from the set of InterfaceOperationElements defined directly within this InterfaceElement. This equates to a named <operation> element declared within the <interface> element. This set does not include operations derived from extended interfaces. If the named InterfaceOperationElement does not exist or if a null value is specified, this method will return null.
      Parameters:
        `operName` - the QName of the required InterfaceOperationElement
      Returns:
        the named InterfaceOperationElement

    - #### getInterfaceOperationElements

          InterfaceOperationElement[] getInterfaceOperationElements()

      Return the set of InterfaceOperationElements defined directly within this InterfaceElement. This equates to the set of <operation> elements declared within this <interface> element. This set does not include operations derived from extended interfaces. If no InterfaceOperationElements exist, an empty array is returned.
      Returns:
        array of InterfaceOperationElement

Copyright ? Apache Software Foundation. All Rights Reserved.