ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.data.events 

DataServiceResultEvent  - AS3 ADEP Data Services
Packagemx.data.events
Classpublic class DataServiceResultEvent
InheritanceDataServiceResultEvent Inheritance ResultEvent Inheritance AbstractEvent Inheritance MessageEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

The DataServiceResultEvent class represents an event that is sent when a DataService or DataStore has generated a result.


Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
  cacheResponse : Boolean
When this property is true this event was dispatched in response to a method call executed against the local cache.
DataServiceResultEvent
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedheaders : Object
In certain circumstances, headers may also be returned with a result to provide further context.
ResultEvent
 Inheritedmessage : IMessage
The Message associated with this event.
MessageEvent
 Inheritedresult : Object
[read-only] Result that the RPC call returns.
ResultEvent
 InheritedstatusCode : int
[read-only] If the source message was sent via HTTP, this property provides access to the HTTP response status code (if available), otherwise the value is 0.
ResultEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtoken : mx.rpc:AsyncToken
[read-only] The token that represents the call to the method.
AbstractEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
DataServiceResultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, result:Object = null, token:mx.rpc:AsyncToken = null, message:IMessage = null, cacheResponse:Boolean = false)
Constructor.
DataServiceResultEvent
 Inherited
clone():Event
[override] Clones the MessageEvent.
MessageEvent
  
createEvent(result:Object, token:mx.rpc:AsyncToken, message:IMessage, cacheResponse:Boolean = false):DataServiceResultEvent
[static] Creates a DataServiceResultEvent object.
DataServiceResultEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
[override] Returns a string representation of the ResultEvent.
ResultEvent
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  RESULT : String = "result"
[static] The RESULT constant defines the value of the type property of the event object for a result event.
DataServiceResultEvent
Property Detail

cacheResponse

property
public var cacheResponse:Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

When this property is true this event was dispatched in response to a method call executed against the local cache. When false this event was dispatched in response to a method call executed against the remote destination.

Constructor Detail

DataServiceResultEvent

()Constructor
public function DataServiceResultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, result:Object = null, token:mx.rpc:AsyncToken = null, message:IMessage = null, cacheResponse:Boolean = false)

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = true) — Specifies whether the behavior associated with the event can be prevented.
 
result:Object (default = null) — Object that holds the actual result of the call.
 
token:mx.rpc:AsyncToken (default = null) — Token representing the call to the method. Used in the asynchronous completion token pattern.
 
message:IMessage (default = null) — Source Message of the fault.
 
cacheResponse:Boolean (default = false) — When true, this event was dispatched in response to a method call executed against the local cache. When false this event was dispatched in response to a method call executed against the remote destination.
Method Detail

createEvent

()method
public static function createEvent(result:Object, token:mx.rpc:AsyncToken, message:IMessage, cacheResponse:Boolean = false):DataServiceResultEvent

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Creates a DataServiceResultEvent object.

Parameters

result:Object — Object that holds the actual result of the call.
 
token:mx.rpc:AsyncToken — Token representing the call to the method. Used in the asynchronous completion token pattern.
 
message:IMessage — Source Message of the fault.
 
cacheResponse:Boolean (default = false) — When true, this event was dispatched in response to a method call executed against the local cache. When false this event was dispatched in response to a method call executed against the remote destination.

Returns
DataServiceResultEvent — The new DataServiceResultEvent object.
Constant Detail

RESULT

Constant
public static const RESULT:String = "result"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

The RESULT constant defines the value of the type property of the event object for a result event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue, calling preventDefault() from the associated token's responder.fault method will prevent the service or operation from dispatching this event
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
result Object that holds the result.
message The Message associated with this event.
token The token that represents the call to the method. Used in the asynchronous completion token pattern.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy