com.ibm.uddi.datatype
Class OverviewDoc

java.lang.Object
  |
  +--com.ibm.uddi.UDDIElement
        |
        +--com.ibm.uddi.datatype.OverviewDoc

public class OverviewDoc
extends UDDIElement

General information:

This class represents an element within the UDDI version 1.0 schema. This class contains the following types of methods:

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 more in-depth or external documentation.


Field Summary
static java.lang.String UDDI_TAG
           
 
Fields inherited from class com.ibm.uddi.UDDIElement
GENERIC, XMLNS
 
Constructor Summary
OverviewDoc()
          Default constructor.
OverviewDoc(org.w3c.dom.Element base)
          Construct the object from a DOM tree.
 
Method Summary
 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 object to DOM tree.
 void setDefaultDescriptionString(java.lang.String s)
          Set default (english) description string
 void setDescriptionVector(java.util.Vector s)
          Set description vector
 void setOverviewURL(OverviewURL s)
           
 void setOverviewURL(java.lang.String s)
           
 
Methods inherited from class com.ibm.uddi.UDDIElement
getChildElementsByTagName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UDDI_TAG

public static final java.lang.String UDDI_TAG
Constructor Detail

OverviewDoc

public OverviewDoc()
Default constructor.

OverviewDoc

public OverviewDoc(org.w3c.dom.Element base)
            throws UDDIException
Construct the object from a DOM tree. Used by UDDIProxy to construct object from 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 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 object to DOM tree. Used to serialize object to a DOM tree, typically to send a UDDI message.
Used by UDDIProxy.
Overrides:
saveToXML in class UDDIElement
Parameters:
parent - Object will serialize as a child element under the passed in parent element.