| Package | com.vmware.data.query.events |
| Class | public class DataByModelRequest |
| Inheritance | DataByModelRequest DataRequest Request flash.events.Event |
| Property | Defined By | ||
|---|---|---|---|
![]() | context : Object
Optional context that might be required to handle the response. | Request | |
| model : Class
Data model class defining properties to retrieve. | DataByModelRequest | ||
| parameters : Object
Parameters to pass to Data Service when retrieving certain properties. | DataByModelRequest | ||
| providerObject : IResourceReference
Reference to the server object to get data for. | DataByModelRequest | ||
![]() | requestId : String | DataRequest | |
![]() | requestInfo : DataRequestInfo
Getting the data request options
| DataRequest | |
| Method | Defined By | ||
|---|---|---|---|
DataByModelRequest(type:String)
Constructor. | DataByModelRequest | ||
addPropertyParameter(property:String, parameter:Object):void
Adds a parameter to be passed to Data Service when retrieving a property
defined in the model. | DataByModelRequest | ||
![]() | clone():Event [override]
Creates a clone of this event. | Request | |
newInstance(provider:IResourceReference, model:Class, requestInfo:DataRequestInfo = null):DataByModelRequest [static]
Returns a new instance. | DataByModelRequest | ||
| Constant | Defined By | ||
|---|---|---|---|
| REQUEST_ID : String = dataRequest [static] | DataByModelRequest | ||
| RESPONSE_ID : String = dataResponse [static] | DataByModelRequest | ||
| model | property |
public var model:ClassData model class defining properties to retrieve.
| parameters | property |
public var parameters:ObjectParameters 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.
See also
| providerObject | property |
public var providerObject:IResourceReferenceReference to the server object to get data for.
| DataByModelRequest | () | Constructor |
public function DataByModelRequest(type:String)Constructor.
Parameterstype:String (default = NaN) |
| addPropertyParameter | () | method |
public function addPropertyParameter(property:String, parameter:Object):voidAdds a parameter to be passed to Data Service when retrieving a property defined in the model.
The parameter can be retrieved on the Java side in the PropertySpec
associated with the query.
Parameters
property:String — The property name as defined in the model.
| |
parameter:Object — The parameter value to passed, it can be any Object but
only one parameter per property is allowed.
|
| newInstance | () | method |
public static function newInstance(provider:IResourceReference, model:Class, requestInfo:DataRequestInfo = null):DataByModelRequestReturns a new instance.
Parameters
provider:IResourceReference — Server object to get data for.
| |
model:Class — Data model class defining properties to retrieve.
| |
requestInfo:DataRequestInfo (default = null) — The data request options
|
DataByModelRequest |
| REQUEST_ID | Constant |
public static const REQUEST_ID:String = dataRequest| RESPONSE_ID | Constant |
public static const RESPONSE_ID:String = dataResponse
[Event(name="dataRequest", type=...)]
public class SomeDataViewMediator extends EventDispatcher {
private function onDataRequestFromView(event:Event):void {
var request:DataByModelRequest =
new DataByModelRequest.newInstance(
vmRef,
model);
dispatchEvent(request);
}
// Option 1 - use EventHandler for the response
[EventHandler(name="dataResponse")]
private function onDataRetrieved(response:SingleObjectDataResponse):void {
// good to go with response.result as VmListItemData
}
// Option 2 - use ResponseHandler for the response
[ResponseHandler(name="dataResponse")]
public function onDataRetrieved(request:DataByModelRequest,
result:VmListItemData,
error:Error):void {
// good to go with type-strict result
}
}