OverviewDoc (UDDI4J API)

java.lang.Object
- org.uddi4j.UDDIElement
- - org.uddi4j.datatype.OverviewDoc

All Implemented Interfaces:

java.io.Serializable
```
public class OverviewDoc
extends UDDIElement
```
Represents the overviewDoc element within the UDDI version 2.0 schema. This class contains the following types of methods:
- Constructor passing the required fields.
- Constructor that will instantiate the object from an appropriate XML DOM element.
- Get/set methods for each attribute that this element can contain.
- For sets of attributes, a get/setVector method is provided.
- SaveToXML method. Serializes this class within a passed in element.
Typically this class is used to construct parameters for, or interpret responses from methods in the UDDIProxy class.
Element description:
Support element - used to contain an on-line description and a URL pointer to additional in-depth or external documentation.
Author:

David Melgar (dmelgar@us.ibm.com)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected org.w3c.dom.Element base

static java.lang.String UDDI_TAG
- Fields inherited from class org.uddi4j.UDDIElement
  GENERIC, SOAPNS, XMLNS, XMLNS_PREFIX

Fields
Modifier and Type	Field	Description
`protected org.w3c.dom.Element`	`base`
`static java.lang.String`	`UDDI_TAG`

Constructor Summary

Constructors
Constructor Description

OverviewDoc()
Default constructor.

OverviewDoc(org.w3c.dom.Element base)
Construct the object from a DOM tree.

Constructors
Constructor	Description
`OverviewDoc()`	Default constructor.
`OverviewDoc(org.w3c.dom.Element base)`	Construct the object from a DOM tree.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object object)`
`java.lang.String`	`getDefaultDescriptionString()`	Get default description string.
`java.util.Vector`	`getDescriptionVector()`	Get description.
`OverviewURL`	`getOverviewURL()`
`java.lang.String`	`getOverviewURLString()`
`void`	`saveToXML(org.w3c.dom.Element parent)`	Save the object to a DOM tree.
`void`	`setDefaultDescriptionString(java.lang.String s)`	Set default (english) description string.
`void`	`setDescriptionVector(java.util.Vector s)`	Set a description vector.
`void`	`setOverviewURL(java.lang.String s)`
`void`	`setOverviewURL(OverviewURL s)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class org.uddi4j.UDDIElement
getChildElementsByTagName, getText

- Field Detail
  - UDDI_TAG
```
public static final java.lang.String UDDI_TAG
```
    See Also:
    
    Constant Field Values
  - base
```
protected org.w3c.dom.Element base
```
- Constructor Detail
  - OverviewDoc
```
public OverviewDoc()
```
    Default constructor. Avoid using the default constructor for validation. It does not validate required fields. Instead, use the required fields constructor to perform validation.
  - OverviewDoc
```
public OverviewDoc(org.w3c.dom.Element base)
            throws UDDIException
```
    Construct the object from a DOM tree. Used by UDDIProxy to construct an object from a received UDDI message.
    
    Parameters:
    
    base - Element with name appropriate for this class.
    
    Throws:
    
    UDDIException - Thrown if DOM tree contains a SOAP fault or disposition report indicating a UDDI error.
- Method Detail
  - setOverviewURL
```
public void setOverviewURL(OverviewURL s)
```
  - setOverviewURL
```
public void setOverviewURL(java.lang.String s)
```
  - setDescriptionVector
```
public void setDescriptionVector(java.util.Vector s)
```
    Set a description vector.
    
    Parameters:
    
    s - Vector of Description objects.
  - setDefaultDescriptionString
```
public void setDefaultDescriptionString(java.lang.String s)
```
    Set default (english) description string.
    
    Parameters:
    
    s - String
  - getOverviewURL
```
public OverviewURL getOverviewURL()
```
  - getOverviewURLString
```
public java.lang.String getOverviewURLString()
```
  - getDescriptionVector
```
public java.util.Vector getDescriptionVector()
```
    Get description.
    
    Returns:
    
    s Vector of Description objects.
  - getDefaultDescriptionString
```
public java.lang.String getDefaultDescriptionString()
```
    Get default description string.
    
    Returns:
    
    s String
  - saveToXML
```
public void saveToXML(org.w3c.dom.Element parent)
```
    Save the object to a DOM tree. Used to serialize an object to a DOM tree, usually to send a UDDI message.
    Used by UDDIProxy.
    
    Specified by:
    
    saveToXML in class UDDIElement
    
    Parameters:
    
    parent - Object will serialize as a child element under the passed in parent element.
  - equals
```
public boolean equals(java.lang.Object object)
```
    Overrides:
    
    equals in class java.lang.Object

Class OverviewDoc

Field Summary

Fields inherited from class org.uddi4j.UDDIElement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from class org.uddi4j.UDDIElement

Field Detail

UDDI_TAG

base

Constructor Detail

OverviewDoc

OverviewDoc

Method Detail

setOverviewURL

setOverviewURL

setDescriptionVector

setDefaultDescriptionString

getOverviewURL

getOverviewURLString

getDescriptionVector

getDefaultDescriptionString

saveToXML

equals