inspireit.uddi.response
Class BusinessList

java.lang.Object
  |
  +--inspireit.uddi.response.BusinessList

All Implemented Interfaces:

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

public class BusinessList

extends java.lang.Object

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

BusinessList represents a businessList response message. The businessList message returns one or more businessInfo structures data sets in response to a find_business inquiry message. BusinessInfo structures are abbreviated versions of businessEntity data suitable for populating lists of search results in anticipation of further "drill-down" detail inquiries.

For information, the XML syntax for a businessList message is:

 <businessList generic="1.0" operator="uddi.sourceOperator" truncated="true" xmlns="urn:uddi-org:api">
     <businessInfos>
         <businessInfo businessKey="F5E65..." >
             <name>My Company</name>
             <serviceInfos>
                 <serviceInfo serviceKey="3D45...">
                     <name>Purchase Orders</name>
                 </serviceInfo>
             </serviceInfos>
         </businessInfo>
         [<businessInfo/>...]
     </businessInfos>
 </businessList>

Yhis message returns overview data in the form of one or more businessInfo structures. Each businessInfo structure contains company name and optional description data, along with a collection element named serviceInfos that in turn can contain one or more serviceInfo structures 14 . Notice that the businessKey attribute is not expressed in the serviceInfo structure due to the fact that this information is available from the containing businessInfo structure.

Author:

Bertrand Fontaine, INSPIRE IT $Revision: 1.2 $

See Also:

Serialized Form

Field Summary

protected BusinessInfos	businessInfos The list of businesses in short form.
protected java.lang.String	generic The UDDI version in use.
protected ListDescription	listDescription
protected Operator	operator The characteristics of the Operator Site.
protected boolean	truncated Whether the Operator Site has truncated or not the result set.

Constructor Summary

BusinessList(BusinessInfos businessInfos, ListDescription listDescription, boolean truncated)
BusinessList constructor.

BusinessList(BusinessInfos businessInfos, java.lang.String generic, Operator operator, boolean truncated)
Deprecated. as of UDDI V3.0

Method Summary

boolean	equals(java.lang.Object o) Checks whether an object is equal to this BusinessList.
BusinessInfos	getBusinessInfos() Gets the list of businesses in short form.
java.lang.String	getGeneric() Deprecated. as of UDDI V3.0
ListDescription	getListDescription()
Operator	getOperator() Deprecated. as of UDDI V3.0
boolean	isTruncated() Checks whether the Operator Site has truncated the result set.
java.lang.Object	visit(inspireit.uddi.util.visitors.UDDIVisitor visitor) Visits this UDDI element.

Methods inherited from class java.lang.Object

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

Field Detail

generic

protected java.lang.String generic

The UDDI version in use.

operator

protected Operator operator

The characteristics of the Operator Site.

truncated

protected boolean truncated

Whether the Operator Site has truncated or not the result set.

businessInfos

protected BusinessInfos businessInfos

The list of businesses in short form.

listDescription

protected ListDescription listDescription

Constructor Detail

BusinessList

public BusinessList(BusinessInfos businessInfos,
                    java.lang.String generic,
                    Operator operator,
                    boolean truncated)

Deprecated. as of UDDI V3.0

BusinessList constructor.

Parameters:

businessInfos - The list of businesses in short form.

generic - The UDDI version in use.

operator - Operator object characterising the Operator Site.

truncated - Whether the Operator Site has truncated or not the result set.

BusinessList

public BusinessList(BusinessInfos businessInfos,
                    ListDescription listDescription,
                    boolean truncated)

BusinessList constructor.

Parameters:

businessInfos - The list of businesses in short form.

truncated - Whether the Operator Site has truncated or not the result set.

Since:

UDDI V3.0

Method Detail

getBusinessInfos

public BusinessInfos getBusinessInfos()

Gets the list of businesses in short form.

Returns:

the list of businesses in short form

getListDescription

public ListDescription getListDescription()

Since:

UDDI V3.0

getGeneric

public java.lang.String getGeneric()

Deprecated. as of UDDI V3.0

Gets the UDDI version in use.

Returns:

the UDDI version in use

getOperator

public Operator getOperator()

Deprecated. as of UDDI V3.0

Gets the characteristics of the Operator Site.

Returns:

the characteristics of the Operator Site as an Operator object

isTruncated

public boolean isTruncated()

Checks whether the Operator Site has truncated the result set.

Returns:

true if the Operator Site has truncated the result set; false otherwise

visit

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

Visits this UDDI element.

Specified by:

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

Parameters:

visitor - The visiting UDDI object.

equals

public boolean equals(java.lang.Object o)

Checks whether an object is equal to this BusinessList.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to test for equality.

Returns:

true if o and this BusinessList are equal; false otherwise