Packagecom.vmware.data.query.events
Classpublic class PropertyRequest
InheritancePropertyRequest Inheritance DataRequest Inheritance Request Inheritance flash.events.Event

Requests property value for a given server object. The result is a DataObject representing the property value. In case the returned property value is of simple type, a wrapper DataObject (e.g. StringDataObject) is returned. For type-strictness, in case of null, null will be returned which will not provide the actual server object ref.

View the examples



Public Properties
 PropertyDefined By
 Inheritedcontext : Object
Optional context that might be required to handle the response.
Request
  parameter : Object
Parameter (1:1) to pass to Data Service when retrieving certain properties.
PropertyRequest
  property : String
Property name.
PropertyRequest
  providerObject : IResourceReference
Reference to the server object to get data for.
PropertyRequest
 InheritedrequestId : String
DataRequest
 InheritedrequestInfo : DataRequestInfo
Getting the data request options
DataRequest
Public Methods
 MethodDefined By
  
PropertyRequest(type:String)
Constructor.
PropertyRequest
 Inherited
clone():Event
[override] Creates a clone of this event.
Request
  
newInstance(providerObject:IResourceReference, property:String, requestInfo:DataRequestInfo = null):PropertyRequest
[static] Returns a new instance.
PropertyRequest
Public Constants
 ConstantDefined By
  REQUEST_ID : String = propertyRequest
[static]
PropertyRequest
  RESPONSE_ID : String = propertyResponse
[static]
PropertyRequest
Property Detail
parameterproperty
public var parameter:Object

Parameter (1:1) to pass to Data Service when retrieving certain properties.

Contains property-parameter values, where the property is in form of relationship.relationship.property, and the parameter is any Object.

propertyproperty 
public var property:String

Property name.

providerObjectproperty 
public var providerObject:IResourceReference

Reference to the server object to get data for.

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

Constructor.

Parameters
type:String (default = NaN)
Method Detail
newInstance()method
public static function newInstance(providerObject:IResourceReference, property:String, requestInfo:DataRequestInfo = null):PropertyRequest

Returns a new instance.

Parameters

providerObject:IResourceReference — Reference to the server object to get data for.
 
property:String — Property name.
 
requestInfo:DataRequestInfo (default = null) — The data request options

Returns
PropertyRequest
Constant Detail
REQUEST_IDConstant
public static const REQUEST_ID:String = propertyRequest

RESPONSE_IDConstant 
public static const RESPONSE_ID:String = propertyResponse

Examples
The following example shows how to use this request:
 [Event(name="propertyRequest", type=...)]
 public class SomeDataViewMediator extends EventDispatcher {
    private function onDataRequestFromView(event:Event):void {
       var request:PropertyRequest =
             new PropertyRequest.newInstance(
                   vmRef,
                   "name");
       dispatchEvent(request);
    }
 
    // Option 1 - use EventHandler for the response
    [EventHandler(name="propertyResponse")]
    private function onDataRetrieved(response:SingleObjectDataResponse):void {
       // good to go with response.result as StringDataObject
    }
 
    // Option 2 - use ResponseHandler for the response
    [ResponseHandler(name="propertyResponse")]
    public function onDataRetrieved(request:PropertyRequest,
                                     result:StringDataObject,
                                     error:Error):void {
       // good to go with type-strict result
    }
 }