Description (base-interfaces 2.4.3 API)

All Superinterfaces:

ExtensibleDocumentedComponent

All Known Subinterfaces:

Definitions
```
public interface Description
extends ExtensibleDocumentedComponent
```
API for WSDL 2.0 Description container.

Author:

ApiGen AX.00

Method Summary

Methods
Modifier and Type	Method and Description
`Binding`	`addNewBinding(String name)` Create a new binding component, appended to this definition's binding list.
`Import`	`addNewImport()` Create a new import component, appended to this definition's import list.
`Include`	`addNewInclude()` Create a new include, appended to this definition's include list.
`Interface`	`addNewInterface(String name)` Create a new interface component, appended to this definition's interface list.
`Service`	`addNewService(String name)` Create a new service component, appended to this definition's service list.
`void`	`appendBinding(Binding theBinding)` Append an item to bindings for this component.
`void`	`appendImport(Import theImport)` Append an item to definitions imported into this container.
`void`	`appendInclude(Include theInclude)` Append an item to definitions included in this container.
`void`	`appendInterface(Interface theInterface)` Append an item to interfaces for this component.
`void`	`appendService(Service theService)` Append an item to services for this component.
`void`	`appendType(Types theType)` Append an item to types (in schema or whatever).
`Binding`	`findBinding(QName name)` Find named binding in this definition or the imported/included bindings.
`Interface`	`findInterface(QName name)` Find named interface in this definition or the imported/included interfaces.
`Service`	`findService(QName name)` Find named service in this definition or the imported/included services.
`Binding`	`getBinding(int index)` Get bindings for this component by indexed position.
`int`	`getBindingsLength()` Get the number of Binding items in bindings.
`String`	`getDocumentBaseUri()` Get base URI for the document for this wsdl:definitions component.
`Import`	`getImport(int index)` Get definitions imported into this container by indexed position.
`int`	`getImportsLength()` Get the number of Import items in imports.
`Include`	`getInclude(int index)` Get definitions included in this container by indexed position.
`int`	`getIncludesLength()` Get the number of Include items in includes.
`Interface`	`getInterface(int index)` Get interfaces for this component by indexed position.
`int`	`getInterfacesLength()` Get the number of Interface items in interfaces.
`Service`	`getService(int index)` Get services for this component by indexed position.
`int`	`getServicesLength()` Get the number of Service items in services.
`String`	`getTargetNamespace()` Get namespace for components in this container.
`Types`	`getType(int index)` Get types (in schema or whatever) by indexed position.
`int`	`getTypesLength()` Get the number of Types items in types.
`Types`	`newTypes()` Create a new types component, replacing the existing types component of this definition, if necessary.
`Binding`	`removeBinding(int index)` Remove bindings for this component by index position.
`Import`	`removeImport(int index)` Remove definitions imported into this container by index position.
`Include`	`removeInclude(int index)` Remove definitions included in this container by index position.
`Interface`	`removeInterface(int index)` Remove interfaces for this component by index position.
`Service`	`removeService(int index)` Remove services for this component by index position.
`Types`	`removeType(int index)` Remove types (in schema or whatever) by index position.
`void`	`setBinding(int index, Binding theBinding)` Set bindings for this component by indexed position.
`void`	`setDocumentBaseUri(String theDocumentBaseUri)` Set base URI for the document for this wsdl:definitions component.
`void`	`setImport(int index, Import theImport)` Set definitions imported into this container by indexed position.
`void`	`setInclude(int index, Include theInclude)` Set definitions included in this container by indexed position.
`void`	`setInterface(int index, Interface theInterface)` Set interfaces for this component by indexed position.
`void`	`setService(int index, Service theService)` Set services for this component by indexed position.
`void`	`setTargetNamespace(String theTargetNamespace)` Set namespace for components in this container.
`void`	`setType(int index, Types theType)` Set types (in schema or whatever) by indexed position.
`Document`	`toXmlDocument()` Return this document as a DOM document.
`String`	`toXmlString()` Return this WSDL definition as an XML string.

Methods inherited from interface com.sun.jbi.wsdl2.ExtensibleDocumentedComponent
getDocument, getDocument, getExtensions, getWsdlAttributeNameMap, setDocument, setDocument, setExtensions

- Method Detail
  - getBindingsLength
```
int getBindingsLength()
```
    Get the number of Binding items in bindings.
    
    Returns:
    The number of Binding items in bindings
  - getBinding
```
Binding getBinding(int index)
```
    Get bindings for this component by indexed position.
    
    Parameters:
    index - Indexed position value 0..length-1
    
    Returns:
    Bindings for this component at given index position.
  - setBinding
```
void setBinding(int index,
              Binding theBinding)
```
    Set bindings for this component by indexed position.
    
    Parameters:
    index - Indexed position value (0..length-1) of the item to set
    theBinding - Item to add at position index.
  - appendBinding
```
void appendBinding(Binding theBinding)
```
    Append an item to bindings for this component.
    
    Parameters:
    theBinding - Item to append to bindings
  - removeBinding
```
Binding removeBinding(int index)
```
    Remove bindings for this component by index position.
    
    Parameters:
    index - The index position of the binding to remove
    
    Returns:
    The Binding removed, if any.
  - getDocumentBaseUri
```
String getDocumentBaseUri()
```
    Get base URI for the document for this wsdl:definitions component.
    
    Returns:
    Base URI for the document for this wsdl:definitions component
  - setDocumentBaseUri
```
void setDocumentBaseUri(String theDocumentBaseUri)
```
    Set base URI for the document for this wsdl:definitions component.
    
    Parameters:
    theDocumentBaseUri - Base URI for the document for this wsdl:definitions component
  - getImportsLength
```
int getImportsLength()
```
    Get the number of Import items in imports.
    
    Returns:
    The number of Import items in imports
  - getImport
```
Import getImport(int index)
```
    Get definitions imported into this container by indexed position.
    
    Parameters:
    index - Indexed position value 0..length-1
    
    Returns:
    Description imported into this container at given index position.
  - setImport
```
void setImport(int index,
             Import theImport)
```
    Set definitions imported into this container by indexed position.
    
    Parameters:
    index - Indexed position value (0..length-1) of the item to set
    theImport - Item to add at position index.
  - appendImport
```
void appendImport(Import theImport)
```
    Append an item to definitions imported into this container.
    
    Parameters:
    theImport - Item to append to imports
  - removeImport
```
Import removeImport(int index)
```
    Remove definitions imported into this container by index position.
    
    Parameters:
    index - The index position of the import to remove
    
    Returns:
    The Import removed, if any.
  - getIncludesLength
```
int getIncludesLength()
```
    Get the number of Include items in includes.
    
    Returns:
    The number of Include items in includes
  - getInclude
```
Include getInclude(int index)
```
    Get definitions included in this container by indexed position.
    
    Parameters:
    index - Indexed position value 0..length-1
    
    Returns:
    Description included in this container at given index position.
  - setInclude
```
void setInclude(int index,
              Include theInclude)
```
    Set definitions included in this container by indexed position.
    
    Parameters:
    index - Indexed position value (0..length-1) of the item to set
    theInclude - Item to add at position index.
  - appendInclude
```
void appendInclude(Include theInclude)
```
    Append an item to definitions included in this container.
    
    Parameters:
    theInclude - Item to append to includes
  - removeInclude
```
Include removeInclude(int index)
```
    Remove definitions included in this container by index position.
    
    Parameters:
    index - The index position of the include to remove
    
    Returns:
    The Include removed, if any.
  - getInterfacesLength
```
int getInterfacesLength()
```
    Get the number of Interface items in interfaces.
    
    Returns:
    The number of Interface items in interfaces
  - getInterface
```
Interface getInterface(int index)
```
    Get interfaces for this component by indexed position.
    
    Parameters:
    index - Indexed position value 0..length-1
    
    Returns:
    Interfaces for this component at given index position.
  - setInterface
```
void setInterface(int index,
                Interface theInterface)
```
    Set interfaces for this component by indexed position.
    
    Parameters:
    index - Indexed position value (0..length-1) of the item to set
    theInterface - Item to add at position index.
  - appendInterface
```
void appendInterface(Interface theInterface)
```
    Append an item to interfaces for this component.
    
    Parameters:
    theInterface - Item to append to interfaces
  - removeInterface
```
Interface removeInterface(int index)
```
    Remove interfaces for this component by index position.
    
    Parameters:
    index - The index position of the interface to remove
    
    Returns:
    The Interface removed, if any.
  - getServicesLength
```
int getServicesLength()
```
    Get the number of Service items in services.
    
    Returns:
    The number of Service items in services
  - getService
```
Service getService(int index)
```
    Get services for this component by indexed position.
    
    Parameters:
    index - Indexed position value 0..length-1
    
    Returns:
    Services for this component at given index position.
  - setService
```
void setService(int index,
              Service theService)
```
    Set services for this component by indexed position.
    
    Parameters:
    index - Indexed position value (0..length-1) of the item to set
    theService - Item to add at position index.
  - appendService
```
void appendService(Service theService)
```
    Append an item to services for this component.
    
    Parameters:
    theService - Item to append to services
  - removeService
```
Service removeService(int index)
```
    Remove services for this component by index position.
    
    Parameters:
    index - The index position of the service to remove
    
    Returns:
    The Service removed, if any.
  - getTargetNamespace
```
String getTargetNamespace()
```
    Get namespace for components in this container.
    
    Returns:
    Namespace for components in this container
  - setTargetNamespace
```
void setTargetNamespace(String theTargetNamespace)
```
    Set namespace for components in this container.
    
    Parameters:
    theTargetNamespace - Namespace for components in this container
  - getTypesLength
```
int getTypesLength()
```
    Get the number of Types items in types.
    
    Returns:
    The number of Types items in types
  - getType
```
Types getType(int index)
```
    Get types (in schema or whatever) by indexed position.
    
    Parameters:
    index - Indexed position value 0..length-1
    
    Returns:
    Types (in schema or whatever) at given index position.
  - setType
```
void setType(int index,
           Types theType)
```
    Set types (in schema or whatever) by indexed position.
    
    Parameters:
    index - Indexed position value (0..length-1) of the item to set
    theType - Item to add at position index.
  - appendType
```
void appendType(Types theType)
```
    Append an item to types (in schema or whatever).
    
    Parameters:
    theType - Item to append to types
  - removeType
```
Types removeType(int index)
```
    Remove types (in schema or whatever) by index position.
    
    Parameters:
    index - The index position of the type to remove
    
    Returns:
    The Types removed, if any.
  - findBinding
```
Binding findBinding(QName name)
```
    Find named binding in this definition or the imported/included bindings.
    
    Parameters:
    name - Name of binding to find.
    
    Returns:
    Named Binding; null if none found.
  - findInterface
```
Interface findInterface(QName name)
```
    Find named interface in this definition or the imported/included interfaces.
    
    Parameters:
    name - Name of interface to find.
    
    Returns:
    Named Interface; null if none found.
  - findService
```
Service findService(QName name)
```
    Find named service in this definition or the imported/included services.
    
    Parameters:
    name - Name of service to find.
    
    Returns:
    Named Service; null if none found.
  - addNewBinding
```
Binding addNewBinding(String name)
```
    Create a new binding component, appended to this definition's binding list.
    
    Parameters:
    name - Name of binding to create.
    
    Returns:
    Newly created binding, appended to the bindings list.
  - addNewImport
```
Import addNewImport()
```
    Create a new import component, appended to this definition's import list.
    
    Returns:
    Newly created import, appended to the imports list.
  - addNewInclude
```
Include addNewInclude()
```
    Create a new include, appended to this definition's include list.
    
    Returns:
    Newly created include, appended to the includes list.
  - addNewInterface
```
Interface addNewInterface(String name)
```
    Create a new interface component, appended to this definition's interface list.
    
    Parameters:
    name - Name of interface to create.
    
    Returns:
    Newly created interface, appended to interfaces list.
  - addNewService
```
Service addNewService(String name)
```
    Create a new service component, appended to this definition's service list.
    
    Parameters:
    name - Name of service to create.
    
    Returns:
    Newly created service, appended to the services list.
  - newTypes
```
Types newTypes()
```
    Create a new types component, replacing the existing types component of this definition, if necessary.
    
    Returns:
    Newly created Types component.
  - toXmlString
```
String toXmlString()
```
    Return this WSDL definition as an XML string.
    
    Returns:
    This definition, serialized as an XML string.
  - toXmlDocument
```
Document toXmlDocument()
```
    Return this document as a DOM document. The DOM tree is a copy; altering it will not affect this definitions component.
    
    Returns:
    This definition, as a DOM document.

Interface Description

Method Summary

Methods inherited from interface com.sun.jbi.wsdl2.ExtensibleDocumentedComponent

Method Detail

getBindingsLength

getBinding

setBinding

appendBinding

removeBinding

getDocumentBaseUri

setDocumentBaseUri

getImportsLength

getImport

setImport

appendImport

removeImport

getIncludesLength

getInclude

setInclude

appendInclude

removeInclude

getInterfacesLength

getInterface

setInterface

appendInterface

removeInterface

getServicesLength

getService

setService

appendService

removeService

getTargetNamespace

setTargetNamespace

getTypesLength

getType

setType

appendType

removeType

findBinding

findInterface

findService

addNewBinding

addNewImport

addNewInclude

addNewInterface

addNewService

newTypes

toXmlString

toXmlDocument