com.vmware.vise.data.query

Class ResultSet

java.lang.Object

com.vmware.vise.data.query.ResultSet

public class ResultSet
extends java.lang.Object

Class representing the result of a particular query.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Exception	error An error that might have occurred while executing the query.
com.vmware.vise.data.query.FacetInfo[]	facets The retrieved facets (internal use only).
ResultItem[]	items The matched objects and the requested data on them.
java.lang.String	queryName The name of the QuerySpec that resulted in this ResultSet, if a name was specified to begin with.
java.lang.Integer	totalMatchedObjectCount The total number of objects that matched the given query, regardless of the actual number that is returned in items.

Constructor Summary

Constructors

Constructor and Description
ResultSet() Default constructor.
ResultSet(ResultSet original) Creates a shallow copy of the specified ResultSet.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

queryName

@optional
public java.lang.String queryName

The name of the QuerySpec that resulted in this ResultSet, if a name was specified to begin with.

totalMatchedObjectCount

@optional
public java.lang.Integer totalMatchedObjectCount

The total number of objects that matched the given query, regardless of the actual number that is returned in items.

Important: This value should only be set by adapters that discover new objects, i.e. it should remain zero for all property providers as they are only returning properties for known objects.

items

public ResultItem[] items

The matched objects and the requested data on them.

facets

public com.vmware.vise.data.query.FacetInfo[] facets

The retrieved facets (internal use only).

error

public java.lang.Exception error

An error that might have occurred while executing the query.

The result of any given query can be coming from one or more data sources (a combination of data adapters and property providers), the error property can be either:

1. DataException to represent the failure to fetch data for some objects and properties.
2. CompositeException to represent a collection of errors (internal use only).
3. Exception for other errors (internal use only).

See Also:

DataException

Constructor Detail

ResultSet

public ResultSet()

Default constructor.

ResultSet

public ResultSet(ResultSet original)

Creates a shallow copy of the specified ResultSet.

Parameters:

original - the object that must be copied

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object