mx.data.events.DataServiceResultEvent - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.data.events
Class	public class DataServiceResultEvent
Inheritance	DataServiceResultEvent ResultEvent AbstractEvent MessageEvent Event Object

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 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

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		bubbles : 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
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		headers : Object In certain circumstances, headers may also be returned with a result to provide further context.	ResultEvent
		message : IMessage The Message associated with this event.	MessageEvent
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		result : Object [read-only] Result that the RPC call returns.	ResultEvent
		statusCode : 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
		target : Object [read-only] The event target.	Event
		token : mx.rpc:AsyncToken [read-only] The token that represents the call to the method.	AbstractEvent
		type : String [read-only] The type of event.	Event

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined 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
		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
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		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
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Returns a string representation of the ResultEvent.	ResultEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		ACTIVATE : String = "activate" [static] The ACTIVATE constant defines the value of the type property of an activate event object.	Event
		ADDED : String = "added" [static] The Event.ADDED constant defines the value of the type property of an added event object.	Event
		ADDED_TO_STAGE : String = "addedToStage" [static] The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.	Event
		CANCEL : String = "cancel" [static] The Event.CANCEL constant defines the value of the type property of a cancel event object.	Event
		CHANGE : String = "change" [static] The Event.CHANGE constant defines the value of the type property of a change event object.	Event
		CLEAR : String = "clear" [static] The Event.CLEAR constant efines the value of the type property of a clear event object.	Event
		CLOSE : String = "close" [static] The Event.CLOSE constant defines the value of the type property of a close event object.	Event
		CLOSING : String = "closing" [static] The Event.CLOSING constant defines the value of the type property of a closing event object.	Event
		COMPLETE : String = "complete" [static] The Event.COMPLETE constant defines the value of the type property of a complete event object.	Event
		CONNECT : String = "connect" [static] The Event.CONNECT constant defines the value of the type property of a connect event object.	Event
		COPY : String = "copy" [static] Defines the value of the type property of a copy event object.	Event
		CUT : String = "cut" [static] Defines the value of the type property of a cut event object.	Event
		DEACTIVATE : String = "deactivate" [static] The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.	Event
		DISPLAYING : String = "displaying" [static] The Event.DISPLAYING constant defines the value of the type property of a displaying event object.	Event
		ENTER_FRAME : String = "enterFrame" [static] The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.	Event
		EXIT_FRAME : String = "exitFrame" [static] The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.	Event
		EXITING : String = "exiting" [static] The Event.EXITING constant defines the value of the type property of an exiting event object.	Event
		FRAME_CONSTRUCTED : String = "frameConstructed" [static] The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.	Event
		FULLSCREEN : String = "fullScreen" [static] The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.	Event
		HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static] The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.	Event
		HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static] The Event.HTML_DOM_INITIALIZE constant defines the value of the type property of an htmlDOMInitialize event object.	Event
		HTML_RENDER : String = "htmlRender" [static] The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.	Event
		ID3 : String = "id3" [static] The Event.ID3 constant defines the value of the type property of an id3 event object.	Event
		INIT : String = "init" [static] The Event.INIT constant defines the value of the type property of an init event object.	Event
		LOCATION_CHANGE : String = "locationChange" [static] The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.	Event
		MESSAGE : String = "message" [static] The MESSAGE event type; dispatched upon receipt of a message.	MessageEvent
		MOUSE_LEAVE : String = "mouseLeave" [static] The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.	Event
		NETWORK_CHANGE : String = "networkChange" [static] The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.	Event
		OPEN : String = "open" [static] The Event.OPEN constant defines the value of the type property of an open event object.	Event
		PASTE : String = "paste" [static] The Event.PASTE constant defines the value of the type property of a paste event object.	Event
		REMOVED : String = "removed" [static] The Event.REMOVED constant defines the value of the type property of a removed event object.	Event
		REMOVED_FROM_STAGE : String = "removedFromStage" [static] The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object.	Event
		RENDER : String = "render" [static] The Event.RENDER constant defines the value of the type property of a render event object.	Event
		RESIZE : String = "resize" [static] The Event.RESIZE constant defines the value of the type property of a resize event object.	Event
		RESULT : String = "result" [static] The RESULT constant defines the value of the type property of the event object for a result event.	DataServiceResultEvent
		SCROLL : String = "scroll" [static] The Event.SCROLL constant defines the value of the type property of a scroll event object.	Event
		SELECT : String = "select" [static] The Event.SELECT constant defines the value of the type property of a select event object.	Event
		SELECT_ALL : String = "selectAll" [static] The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.	Event
		SOUND_COMPLETE : String = "soundComplete" [static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.	Event
		STANDARD_ERROR_CLOSE : String = "standardErrorClose" [static] The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.	Event
		STANDARD_INPUT_CLOSE : String = "standardInputClose" [static] The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.	Event
		STANDARD_OUTPUT_CLOSE : String = "standardOutputClose" [static] The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.	Event
		TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.	Event
		TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object.	Event
		TAB_INDEX_CHANGE : String = "tabIndexChange" [static] The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object.	Event
		UNLOAD : String = "unload" [static] The Event.UNLOAD constant defines the value of the type property of an unload event object.	Event
		USER_IDLE : String = "userIdle" [static] The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.	Event
		USER_PRESENT : String = "userPresent" [static] The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.	Event

Property Detail

cacheResponse

property

public var cacheResponse:Boolean

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 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:

LiveCycle Data Services 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:

LiveCycle Data Services 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:

LiveCycle Data Services 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:

Property	Value
`bubbles`	false
`cancelable`	true, calling preventDefault() from the associated token's responder.fault method will prevent the service or operation from dispatching this event
`currentTarget`	The 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.
`target`	The 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.