Packagecom.vmware.data.query.events
Classpublic class DataByQuerySpecRequest
InheritanceDataByQuerySpecRequest Inheritance DataRequest Inheritance Request Inheritance flash.events.Event

Requests data by a given QuerySpec. The result is an ArrayCollection of ObjectDataObject's. The Object contains the properties retrieved.

View the examples



Public Properties
 PropertyDefined By
 Inheritedcontext : Object
Optional context that might be required to handle the response.
Request
  querySpec : QuerySpec
QuerySpec to use for the data retrieval.
DataByQuerySpecRequest
 InheritedrequestId : String
DataRequest
 InheritedrequestInfo : DataRequestInfo
Getting the data request options
DataRequest
Public Methods
 MethodDefined By
  
Constructor.
DataByQuerySpecRequest
 Inherited
clone():Event
[override] Creates a clone of this event.
Request
  
[static] Returns a new instance.
DataByQuerySpecRequest
Public Constants
 ConstantDefined By
  REQUEST_ID : String = dataByQuerySpecRequest
[static]
DataByQuerySpecRequest
  RESPONSE_ID : String = dataByQuerySpecResponse
[static]
DataByQuerySpecRequest
Property Detail
querySpecproperty
public var querySpec:QuerySpec

QuerySpec to use for the data retrieval. Defines matching objects as well as properties to retrieve.

Constructor Detail
DataByQuerySpecRequest()Constructor
public function DataByQuerySpecRequest(type:String)

Constructor.

Parameters
type:String (default = NaN)
Method Detail
newInstance()method
public static function newInstance(querySpec:QuerySpec, requestInfo:DataRequestInfo = null):DataByQuerySpecRequest

Returns a new instance.

Parameters

querySpec:QuerySpec — QuerySpec specifying how to find matching objects and which properties to get.
 
requestInfo:DataRequestInfo (default = null) — The data request options

Returns
DataByQuerySpecRequest
Constant Detail
REQUEST_IDConstant
public static const REQUEST_ID:String = dataByQuerySpecRequest

RESPONSE_IDConstant 
public static const RESPONSE_ID:String = dataByQuerySpecResponse

Examples
The following example shows how to use this request:
 [Event(name="dataByQuerySpecRequest", type=...)]
 public class SomeDataViewMediator extends EventDispatcher {
    private function onDataRequestFromView(event:Event):void {
       // create a query spec to execute
       var querySpec:QuerySpec;
 
       var request:DataByQuerySpecRequest =
             new DataByQuerySpecRequest.newInstance(querySpec);
       dispatchEvent(request);
    }
 
    // Option 1 - use EventHandler for the response
    [EventHandler(name="dataByQuerySpecResponse")]
    private function onDataRetrieved(response:MultiObjectDataResponse):void {
       var result1:convertToDataObject = response.result[0] as convertToDataObject;
       _logger.info("server object: " + result1.sourceInfo_.provider.toString());
       _logger.info("property1: " + result1.value["property1"]);
       _logger.info("property2: " + result1.value["property2"]);
    }
 
    // Option 2 - use ResponseHandler for the response
    [ResponseHandler(name="dataByQuerySpecResponse")]
    public function onDataRetrieved(request:DataByQuerySpecRequest,
                                     result:ArrayCollection,
                                     error:Error):void {
       var result1:convertToDataObject = result[0] as convertToDataObject;
       _logger.info("server object: " + result1.sourceInfo_.provider.toString());
       _logger.info("property1: " + result1.value["property1"]);
       _logger.info("property2: " + result1.value["property2"]);
    }
 }