vSphere Client SDK API Documentation : version 5.5.0.1300321

com.vmware.vise.data.query
Class ResultSet

java.lang.Object
  extended by com.vmware.vise.data.query.ResultSet

@data(base="Object")
public class ResultSet
extends Object

Class representing the result of a particular query.


Field Summary
 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.
 String queryName
          The name of the QuerySpec that resulted in this ResultSet, if a name was specified to begin with.
 Integer totalMatchedObjectCount
          The total number of objects that matched the given query, regardless of the actual number that is returned in items.
 
Constructor Summary
ResultSet()
          Default constructor.
ResultSet(ResultSet original)
          Creates a shallow copy of the specified ResultSet.
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

queryName

@optional
public String queryName
The name of the QuerySpec that resulted in this ResultSet, if a name was specified to begin with.


totalMatchedObjectCount

@optional
public 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 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

vSphere Client SDK API Documentation : version 5.5.0.1300321

Copyright @ 2012 VMware, Inc. All rights reserved.