Packagecom.vmware.data.query
Classpublic class ResultSet
InheritanceResultSet Inheritance Object
Implements flash.events.IEventDispatcher

Class representing the result of a particular query.

Note: this class was generated from its Java counterpart ResultSet



Public Properties
 PropertyDefined By
  error : Error
An error that might have occurred while executing the query.
ResultSet
  facets : Array
The retrieved facets (internal use only).
ResultSet
  items : Array
The matched objects and the requested data on them.
ResultSet
  queryName : String
The name of the QuerySpec that resulted in this ResultSet, if a name was specified to begin with.
ResultSet
  totalMatchedObjectCount : Number
The total number of objects that matched the given query, regardless of the actual number that is returned in items.
ResultSet
Public Methods
 MethodDefined By
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
ResultSet
  
dispatchEvent(event:Event):Boolean
ResultSet
  
hasEventListener(type:String):Boolean
ResultSet
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
ResultSet
  
willTrigger(type:String):Boolean
ResultSet
Property Detail
errorproperty
error: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).

This property can be used as the source for data binding.


Implementation
    public function get error():Error
    public function set error(value:Error):void

See also

facetsproperty 
facets:Array

The retrieved facets (internal use only).

This property can be used as the source for data binding.


Implementation
    public function get facets():Array
    public function set facets(value:Array):void
itemsproperty 
items:Array

The matched objects and the requested data on them.

This property can be used as the source for data binding.


Implementation
    public function get items():Array
    public function set items(value:Array):void
queryNameproperty 
queryName:String

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

This property can be used as the source for data binding.


Implementation
    public function get queryName():String
    public function set queryName(value:String):void
totalMatchedObjectCountproperty 
totalMatchedObjectCount:Number

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.

This property can be used as the source for data binding.


Implementation
    public function get totalMatchedObjectCount():Number
    public function set totalMatchedObjectCount(value:Number):void
Method Detail
addEventListener()method
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
 
weakRef:Boolean (default = false)

dispatchEvent()method 
public function dispatchEvent(event:Event):Boolean

Parameters

event:Event

Returns
Boolean
hasEventListener()method 
public function hasEventListener(type:String):Boolean

Parameters

type:String

Returns
Boolean
removeEventListener()method 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)

willTrigger()method 
public function willTrigger(type:String):Boolean

Parameters

type:String

Returns
Boolean