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 

DataServiceFaultEvent  - AS3 ADEP Data Services
Packagemx.data.events
Classpublic class DataServiceFaultEvent
InheritanceDataServiceFaultEvent Inheritance FaultEvent Inheritance AbstractEvent Inheritance MessageEvent Inheritance Event Inheritance Object
Subclasses UnresolvedConflictsEvent

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 DataServiceFaultEvent class represents an event that is sent when a DataService or DataStore has generated a fault. If the fault was generated for a specific item, the item and/or its identity can be retrieved from this fault.


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.
DataServiceFaultEvent
 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
 Inheritedfault : Fault
[read-only] The Fault object that contains the details of what caused this event.
FaultEvent
 Inheritedheaders : Object
In certain circumstances, headers may also be returned with a fault to provide further context to the failure.
FaultEvent
  identity : Object
The identity of the item that generated the fault.
DataServiceFaultEvent
  item : Object
Stores the item that generated the fault.
DataServiceFaultEvent
 Inheritedmessage : IMessage
The Message associated with this event.
MessageEvent
 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.
FaultEvent
 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
  
DataServiceFaultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, fault:Fault = null, token:mx.rpc:AsyncToken = null, message:ErrorMessage = null, obj:Object = null, id:Object = null, cacheResponse:Boolean = false)
Constructor.
DataServiceFaultEvent
 Inherited
clone():Event
[override] Clones the MessageEvent.
MessageEvent
  
createEvent(fault:Fault, token:mx.rpc:AsyncToken, message:ErrorMessage, obj:Object, id:Object, cacheResponse:Boolean = false):DataServiceFaultEvent
[static] Creates a DataServiceFaultEvent object.
DataServiceFaultEvent
 Inherited
createEventFromMessageFault(value:MessageFaultEvent, token:mx.rpc:AsyncToken = null):FaultEvent
[static] Given a MessageFaultEvent, this method constructs and returns a FaultEvent.
FaultEvent
 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 FaultEvent.
FaultEvent
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  FAULT : String = "fault"
[static] The FAULT constant defines the value of the type property of the event object for a fault event.
DataServiceFaultEvent
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.

identity

property 
public var identity: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 identity of the item that generated the fault. This is null if there was no single item associated with the fault.

item

property 
public var item: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

Stores the item that generated the fault. This is null if no item was available or this fault occurred due to the failure of a batch of items.

Constructor Detail

DataServiceFaultEvent

()Constructor
public function DataServiceFaultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, fault:Fault = null, token:mx.rpc:AsyncToken = null, message:ErrorMessage = null, obj:Object = null, id:Object = 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.
 
fault:Fault (default = null) — Object that holds details of the fault, including a faultCode and faultString.
 
token:mx.rpc:AsyncToken (default = null) — Token representing the call to the method. Used in the asynchronous completion token pattern.
 
message:ErrorMessage (default = null) — Source Message of the fault.
 
obj:Object (default = null) — The item that generated the fault.
 
id:Object (default = null) — The identity of the item that generated 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(fault:Fault, token:mx.rpc:AsyncToken, message:ErrorMessage, obj:Object, id:Object, cacheResponse:Boolean = false):DataServiceFaultEvent

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 DataServiceFaultEvent object.

Parameters

fault:Fault — Object that holds details of the fault, including a faultCode and faultString.
 
token:mx.rpc:AsyncToken — Token representing the call to the method. Used in the asynchronous completion token pattern.
 
message:ErrorMessage — Source Message of the fault.
 
obj:Object — The item that generated the fault.
 
id:Object — The identity of the item that generated 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
DataServiceFaultEvent — The new DataServiceFaultEvent object.
Constant Detail

FAULT

Constant
public static const FAULT:String = "fault"

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 FAULT constant defines the value of the type property of the event object for a fault 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.
fault The Fault object that holds the conflict that occurred.
item The item that generated the fault.
identity The identity of of the item that generated the fault.
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