inspireit.uddi.response.base
Class ListDescription

java.lang.Object
  |
  +--inspireit.uddi.response.base.ListDescription

All Implemented Interfaces:

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

public class ListDescription

extends java.lang.Object

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

Several of the inquiry APIs cause a list of results to be returned. In such cases, an ListDescription may also be returned.

Since:

UDDI V3.0

Author:

Bertrand Fontaine, INSPIRE IT $Revision: 1.2 $

See Also:

Serialized Form

Field Summary

protected int	actualCount The actual overall number of matches.
protected int	includeCount The number of list items returned.
protected int	listHead The index (with origin of 1) of the first element of the returned result set within the overall set of matches.

Constructor Summary

ListDescription(int includeCount, int actualCount, int listHead)
ListDescription constructor.

Method Summary

int	getActualCount() Gets the actual overall number of matches.
int	getIncludeCount() Gets the number of list items returned.
int	getListHead() Gets the index (with origin of 1) of the first element of the returned result set within the overall set of matches.
java.lang.Object	visit(inspireit.uddi.util.visitors.UDDIVisitor visitor) Visits this UDDI element.

Methods inherited from class java.lang.Object

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

Field Detail

includeCount

protected int includeCount

The number of list items returned.

actualCount

protected int actualCount

The actual overall number of matches.

listHead

protected int listHead

The index (with origin of 1) of the first element of the returned result set within the overall set of matches.

Constructor Detail

ListDescription

public ListDescription(int includeCount,
                       int actualCount,
                       int listHead)

ListDescription constructor.

Parameters:

includeCount - The number of list items returned.

actualCount - The actual overall number of matches.

listHead - The index (with origin of 1) of the first element of the returned result set within the overall set of matches.

Method Detail

getIncludeCount

public int getIncludeCount()

Gets the number of list items returned.

Returns:

the number of list items returned

getActualCount

public int getActualCount()

Gets the actual overall number of matches.

Returns:

the actual overall number of matches

getListHead

public int getListHead()

Gets the index (with origin of 1) of the first element of the returned result set within the overall set of matches.

Returns:

the index of the first element in the overall set of matches

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.