(Preview)
| Package | mx.data.events |
| Class | public class DataServiceFaultEvent |
| Inheritance | DataServiceFaultEvent  FaultEvent AbstractEvent MessageEvent Event Object |
| Subclasses | UnresolvedConflictsEvent |
| Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. | DataServiceFaultEvent | ||
| 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 | |
| fault : Fault [read-only]
The Fault object that contains the details of what caused this event. | FaultEvent | |
| headers : 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 | ||
| message : IMessage
The Message associated with this event. | MessageEvent | |
| 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. | FaultEvent | |
| 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
| Method | Defined 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 | ||
| [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 | ||
| [static]
Given a MessageFaultEvent, this method constructs and
returns a FaultEvent. | FaultEvent | |
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string representation of the FaultEvent. | FaultEvent | |
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined 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: | LiveCycle 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: | LiveCycle 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: | LiveCycle 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: | LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
Parameterstype:String — The event type; indicates the action that caused the event.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = true) | |
fault:Fault (default = null)faultCode and faultString.
| |
token:mx.rpc:AsyncToken (default = null) | |
message:ErrorMessage (default = null) | |
obj:Object (default = null) | |
id:Object (default = null) | |
cacheResponse:Boolean (default = false)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: | LiveCycle 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)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.
|
DataServiceFaultEvent — The new DataServiceFaultEvent object.
|
Constant Detail
FAULT | Constant |
public static const FAULT:String = "fault"| Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle 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:
| 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. |
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. |
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. |
Wed Nov 21 2018, 06:34 AM -08:00