| Package | com.vmware.data.query.events |
| Class | public class PropertyRequest |
| Inheritance | PropertyRequest DataRequest Request flash.events.Event |
| Property | Defined By | ||
|---|---|---|---|
![]() | context : 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 | ||
![]() | requestId : String | DataRequest | |
![]() | requestInfo : DataRequestInfo
Getting the data request options
| DataRequest | |
| Method | Defined By | ||
|---|---|---|---|
PropertyRequest(type:String)
Constructor. | PropertyRequest | ||
![]() | 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 | ||
| Constant | Defined By | ||
|---|---|---|---|
| REQUEST_ID : String = propertyRequest [static] | PropertyRequest | ||
| RESPONSE_ID : String = propertyResponse [static] | PropertyRequest | ||
| parameter | property |
public var parameter:ObjectParameter (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.
| property | property |
public var property:StringProperty name.
| providerObject | property |
public var providerObject:IResourceReferenceReference to the server object to get data for.
| PropertyRequest | () | Constructor |
public function PropertyRequest(type:String)Constructor.
Parameterstype:String (default = NaN) |
| newInstance | () | method |
public static function newInstance(providerObject:IResourceReference, property:String, requestInfo:DataRequestInfo = null):PropertyRequestReturns 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
|
PropertyRequest |
| REQUEST_ID | Constant |
public static const REQUEST_ID:String = propertyRequest| RESPONSE_ID | Constant |
public static const RESPONSE_ID:String = propertyResponse
[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
}
}