org.apache.woden.wsdl20

## Interface Description

- All Superinterfaces:
    PropertyExtensible, WSDLComponent
  All Known Subinterfaces:
    EdDescription

      public interface Description
      extends WSDLComponent

  Represents the Description component from the WSDL 2.0 Component model, as described in the W3C WSDL 2.0 specification. It provides an abstract view of a WSDL document by flattening the composite document structure created by the use of <wsdl:import> or <wsdl:include> elements into a single WSDL Description component containing the WSDL components declared within the root <description> and within any imported or included descriptions.

  In other words, if a WSDL component model is derived from composite WSDL document made up of WSDL imports or includes, then its Description component acts as a container for all of the top-level WSDL components in the WSDL tree, starting with the root <description> element. These top-level WSDL components include Interface, Binding, Service, ElementDeclaration and TypeDefinition.

  Author:
    John Kaputin (jkaputin@apache.org)

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `Binding` | `getBinding(QName name)` Returns a Binding with the specified name from the {bindings} property of this Description.
    `Binding[]` | `getBindings()` Represents the {bindings} property of the Description component.
    `ElementDeclaration` | `getElementDeclaration(QName name)` Returns the ElementDeclaration with the specified name from the set of ElementDeclarations represented by the {element declarations} property of this Description.
    `ElementDeclaration[]` | `getElementDeclarations()` Represents the {element declarations} property of the Description component.
    `Interface` | `getInterface(QName name)` Returns an Interface with the specified name from the {interfaces} property of this Description.
    `Interface[]` | `getInterfaces()` Represents the {interfaces} property of the Description component.
    `Service` | `getService(QName name)` Returns a Service with the specified name from the {services} property of this Description.
    `Service[]` | `getServices()` Represents the {services} property of the Description component.
    `TypeDefinition` | `getTypeDefinition(QName name)` Returns the TypeDefinition with the specified name from the set of TypeDefinitions represented by the {type definitions} property of this Description.
    `TypeDefinition[]` | `getTypeDefinitions()` Represents the {type definitions} property of the Description component.
    `DescriptionElement` | `toElement()` Returns a WSDLElement that represents the element information item from the WSDL 2.0 infoset that maps to this WSDLComponent.

    - ### Methods inherited from interface org.apache.woden.wsdl20.WSDLComponent

      `equals, getComponentExtensionContext, getFragmentIdentifier, isEquivalentTo, setComponentExtensionContext, toString`

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

      `getExtensionProperties, getExtensionProperties, getExtensionProperty`

- - ### Method Detail

    - #### getInterfaces

          Interface[] getInterfaces()

      Represents the {interfaces} property of the Description component. This is the set of all interfaces available to the Description, including those that are declared in the root WSDL document and any declared in included or imported WSDL documents.
      Returns:
        an array of Interface objects

    - #### getInterface

          Interface getInterface(QName name)

      Returns an Interface with the specified name from the {interfaces} property of this Description.
      Parameters:
        `name` - the QName of the required Interface
      Returns:
        an Interface with the specified name

    - #### getBindings

          Binding[] getBindings()

      Represents the {bindings} property of the Description component. This is the set of all bindings available to the Description, including those that are declared in the root WSDL document and any declared in included or imported WSDL documents.
      Returns:
        an array of Binding objects

    - #### getBinding

          Binding getBinding(QName name)

      Returns a Binding with the specified name from the {bindings} property of this Description.
      Parameters:
        `name` - the QName of the required Binding
      Returns:
        a Binding with the specified name

    - #### getServices

          Service[] getServices()

      Represents the {services} property of the Description component. This is the set of all services available to the Description, including those that are declared in the root WSDL document and any declared in included or imported WSDL documents.
      Returns:
        an array of Service objects

    - #### getService

          Service getService(QName name)

      Returns a Service with the specified name from the {services} property of this Description.
      Parameters:
        `name` - the QName of the required Service
      Returns:
        a Service with the specified name

    - #### getElementDeclarations

          ElementDeclaration[] getElementDeclarations()

      Represents the {element declarations} property of the Description component. This is the set of all global element declarations available to the Description, including those that are declared by schemas inlined or imported by the root WSDL document and those declared by schemas inlined or imported by WSDL documents that the root WSDL document includes or imports, directly or indirectly.
      Returns:
        an array of ElementDeclaration objects

    - #### getElementDeclaration

          ElementDeclaration getElementDeclaration(QName name)

      Returns the ElementDeclaration with the specified name from the set of ElementDeclarations represented by the {element declarations} property of this Description.
      Parameters:
        `name` - the QName of the required ElementDeclaration
      Returns:
        the named ElementDeclaration

    - #### getTypeDefinitions

          TypeDefinition[] getTypeDefinitions()

      Represents the {type definitions} property of the Description component. This is the set of all global type definitions available to the Description, including those that are defined by schemas inlined or imported by the root WSDL document and those defined by schemas inlined or imported by WSDL documents that the root WSDL document includes or imports, directly or indirectly.
      Returns:
        an array of TypeDefinition objects

    - #### getTypeDefinition

          TypeDefinition getTypeDefinition(QName name)

      Returns the TypeDefinition with the specified name from the set of TypeDefinitions represented by the {type definitions} property of this Description.
      Parameters:
        `name` - the QName of the required TypeDefinition
      Returns:
        the named TypeDefinition

    - #### toElement

          DescriptionElement toElement()

      Returns a WSDLElement that represents the element information item from the WSDL 2.0 infoset that maps to this WSDLComponent.

      The Description component is unlike other WSDL components which map neatly to a single WSDL element. Description represents a 'flattened' view of the entire WSDL infoset tree, including the WSDL components from any imported or included WSDL documents, so it could contain the content of multiple <wsdl:description> elements.

      If the Component model has been derived from such a composite WSDL infoset, the behaviour of this method is to return the DescriptionElement that represents the root <wsdl:description> element.

      Returns:
        the DescriptionElement that maps to this Description

Copyright ? Apache Software Foundation. All Rights Reserved.