inspireit.uddi.base
Class OverviewDoc

java.lang.Object
  |
  +--inspireit.uddi.base.OverviewDoc

All Implemented Interfaces:

java.io.Serializable, inspireit.uddi.util.visitors.UDDIElement

public class OverviewDoc

extends java.lang.Object

implements java.io.Serializable, inspireit.uddi.util.visitors.UDDIElement

OverviewDoc is a placeholder for metadata that describes overview information about a particular TModel use within a BindingTemplate.

Author:

Bertrand Fontaine, INSPIRE IT $Revision: 1.2 $

See Also:

Serialized Form

Field Summary

protected Descriptions	descriptions Set of short descriptive overviews of how a particular TModel is to be used.
protected OverviewURL	overviewURL Holds a URL reference to a long form of an overview document that covers the way a particular TModel specific reference is used as a component of an overall Web service description.

Constructor Summary

OverviewDoc()
Deprecated. as of UDDI V3.0

OverviewDoc(Descriptions descriptions)
OverviewDoc constructor.

OverviewDoc(OverviewURL overviewURL)
OverviewDoc constructor.

Method Summary

void	addDescription(Description description) Adds a Description to the list of short descriptive overviews of how a particular TModel is to be used.
boolean	equals(java.lang.Object o) Checks whether an object is equal to this OverviewDoc.
Descriptions	getDescriptions() Gets all descriptive overviews of how a particular TModel is to be used.
OverviewURL	getOverviewURL() Gets the OverviewURL holding a URL reference to a long form of an overview document that covers the way a particular TModel specific reference is used as a component of an overall Web service description.
void	removeDescription(Description description) Removes a Description from the list of short descriptive overviews of how a particular TModel is to be used.
void	setOverviewURL(OverviewURL overviewURL) Sets the OverviewURL holding a URL reference to a long form of an overview document that covers the way a particular TModel specific reference is used as a component of an overall Web service description.
java.lang.Object	visit(inspireit.uddi.util.visitors.UDDIVisitor visitor) Visits this OverviewDoc.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

descriptions

protected Descriptions descriptions

Set of short descriptive overviews of how a particular TModel is to be used.

overviewURL

protected OverviewURL overviewURL

Holds a URL reference to a long form of an overview document that covers the way a particular TModel specific reference is used as a component of an overall Web service description.

Constructor Detail

OverviewDoc

public OverviewDoc()

Deprecated. as of UDDI V3.0

OverviewDoc constructor.

OverviewDoc

public OverviewDoc(OverviewURL overviewURL)

OverviewDoc constructor.

Parameters:

overviewURL -

Since:

UDDI V3.0

OverviewDoc

public OverviewDoc(Descriptions descriptions)

OverviewDoc constructor.

Parameters:

descriptions -

Since:

UDDI V3.0

Method Detail

addDescription

public void addDescription(Description description)

Adds a Description to the list of short descriptive overviews of how a particular TModel is to be used.

Parameters:

description - The Description to add to the list.

removeDescription

public void removeDescription(Description description)

Removes a Description from the list of short descriptive overviews of how a particular TModel is to be used.

Parameters:

description - The Description to remove from the list.

getDescriptions

public Descriptions getDescriptions()

Gets all descriptive overviews of how a particular TModel is to be used.

Returns:

Descriptions of how a particular TModel is to be used

setOverviewURL

public void setOverviewURL(OverviewURL overviewURL)

Sets the OverviewURL holding a URL reference to a long form of an overview document that covers the way a particular TModel specific reference is used as a component of an overall Web service description.

Parameters:

overviewURL - The OverviewURL to associate to this OverviewDoc.

getOverviewURL

public OverviewURL getOverviewURL()

Gets the OverviewURL holding a URL reference to a long form of an overview document that covers the way a particular TModel specific reference is used as a component of an overall Web service description.

Returns:

the OverviewURL associated to this OverviewDoc

visit

public java.lang.Object visit(inspireit.uddi.util.visitors.UDDIVisitor visitor)

Visits this OverviewDoc.

Specified by:

visit in interface inspireit.uddi.util.visitors.UDDIElement

Parameters:

visitor - The Visitor visiting this OverviewDoc.

equals

public boolean equals(java.lang.Object o)

Checks whether an object is equal to this OverviewDoc. Two OverviewDocs are equal if they have the same pointer.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to test for equality.

Returns:

true if o and this OverviewDoc are equal; false otherwise