|
vSphere Client SDK API Documentation : version 5.5.0.1300321 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.vmware.vise.data.query.ResultSet
@data(base="Object") public class ResultSet
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 |
---|
@optional public String queryName
QuerySpec
that resulted in this
ResultSet
, if a name was specified to begin with.
@optional public Integer totalMatchedObjectCount
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.
public ResultItem[] items
public com.vmware.vise.data.query.FacetInfo[] facets
public Exception error
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:
DataException
to represent the failure to fetch data for
some objects and properties.CompositeException
to represent a collection of errors
(internal use only).Exception
for other errors (internal use only).
DataException
Constructor Detail |
---|
public ResultSet()
public ResultSet(ResultSet original)
ResultSet
.
original
- the object that must be copied
|
vSphere Client SDK API Documentation : version 5.5.0.1300321 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |