Package org.uddi4j.datatype
Class OverviewDoc
java.lang.Object
org.uddi4j.UDDIElement
org.uddi4j.datatype.OverviewDoc
- All Implemented Interfaces:
Serializable
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.
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:
-
Field Summary
FieldsFields inherited from class org.uddi4j.UDDIElement
GENERIC, SOAPNS, XMLNS, XMLNS_PREFIX
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.OverviewDoc
(Element base) Construct the object from a DOM tree. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Get default description string.Get description.void
Save the object to a DOM tree.void
Set default (english) description string.void
Set a description vector.void
void
Methods inherited from class org.uddi4j.UDDIElement
getChildElementsByTagName, getText
-
Field Details
-
UDDI_TAG
- See Also:
-
base
-
-
Constructor Details
-
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
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 Details
-
setOverviewURL
-
setOverviewURL
-
setDescriptionVector
Set a description vector.- Parameters:
s
- Vector of Description objects.
-
setDefaultDescriptionString
Set default (english) description string.- Parameters:
s
- String
-
getOverviewURL
-
getOverviewURLString
-
getDescriptionVector
Get description.- Returns:
- s Vector of Description objects.
-
getDefaultDescriptionString
Get default description string.- Returns:
- s String
-
saveToXML
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 classUDDIElement
- Parameters:
parent
- Object will serialize as a child element under the passed in parent element.
-
equals
-