View comments | RSS feed
(Adobe® Flex™ Data Services 2 only)
Packagemx.data
Interfacepublic interface IChangeObject

The IChangeObject interface provides the methods and properties needed when decting local conflicts. Conflicts represent an error that has occurred due to an update operation. Conflicts are generated for many reasons. For example, another client has updated the same property of an item. Conflicts are determined by both the remote destination and the local DataService. A conflict detected by the DataService is considered a local conflict. A conflict detected by the remote destination is a remote conflict. This interface is used when detecting local conflicts. Local conflicts are determined by the ConflictDetector object. To customize local conflict detection the ConflictDetector can be extended and assigned to the DataService.conflictDetector property.


Public Properties
 PropertyDefined by
  changedPropertyNames : Array
[read-only] Returns the list of property names which changed as part of an update.
IChangeObject
  currentVersion : Object
[read-only] New version of the item.
IChangeObject
  identity : Object
[read-only] Identity of the item being changed.
IChangeObject
  message : DataMessage
[read-only] Provides access to the local DataMessage corresponding to the local changes.
IChangeObject
  newVersion : Object
[read-only] Remote destinations current version of the item.
IChangeObject
  previousVersion : Object
[read-only] Previous version of the item.
IChangeObject
Public Methods
 MethodDefined by
  
conflict(description:String, properties:Array):void
Declares that a conflict occurred while processing this change.
IChangeObject
  
getConflict():DataErrorMessage
Returns the conflict created with a previous call to the conflict() method.
IChangeObject
  
isCreate():Boolean
Indicates if the change is due to a new item.
IChangeObject
  
isDelete():Boolean
Indicates if the item was deleted.
IChangeObject
  
isUpdate():Boolean
Indicates if the change is due to an update.
IChangeObject
Property detail
changedPropertyNamesproperty
changedPropertyNames:Array  [read-only]

Returns the list of property names which changed as part of an update. If this method returns null, it is in indication that all properties may have changed.

Implementation
    public function get changedPropertyNames():Array
currentVersionproperty 
currentVersion:Object  [read-only]

New version of the item.

Implementation
    public function get currentVersion():Object
identityproperty 
identity:Object  [read-only]

Identity of the item being changed.

Implementation
    public function get identity():Object
messageproperty 
message:DataMessage  [read-only]

Provides access to the local DataMessage corresponding to the local changes.

Implementation
    public function get message():DataMessage
newVersionproperty 
newVersion:Object  [read-only]

Remote destinations current version of the item.

Implementation
    public function get newVersion():Object
previousVersionproperty 
previousVersion:Object  [read-only]

Previous version of the item.

Implementation
    public function get previousVersion():Object
Method detail
conflict()method
public function conflict(description:String, properties:Array):void

Declares that a conflict occurred while processing this change. The conflict will be dispatched as a ConflictEvent on the DataService. The specified properites list will indicate which properites are in conflict. The specified description will be available on the faultString property of the event's message property.

Parameters
description:String
 
properties:Array
getConflict()method 
public function getConflict():DataErrorMessage

Returns the conflict created with a previous call to the conflict() method.

Returns
DataErrorMessage
isCreate()method 
public function isCreate():Boolean

Indicates if the change is due to a new item.

Returns
Boolean
isDelete()method 
public function isDelete():Boolean

Indicates if the item was deleted.

Returns
Boolean
isUpdate()method 
public function isUpdate():Boolean

Indicates if the change is due to an update.

Returns
Boolean



© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Jun 22 2006, 10:21 PM GMT-07:00

Comments


Brian Mantuano said on Apr 23, 2008 at 11:32 AM :
Small typo in class description: "when decting local conflicts" should be "when detecting local conflicts"

 

RSS feed | Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flex/2/langref/mx/data/IChangeObject.html