Packagemx.data
Classpublic class Conflict
InheritanceConflict Inheritance Error Inheritance Object

The Conflict class is used to represent 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.

Custom assemblers can generate a remote conflict for any operation when processing an update. 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.

All conflicts must be resolved before changes can be committed.


Public Properties
 PropertyDefined By
  cause : DataMessage
[read-only] Returns the DataMessage object that caused the conflict.
Conflict
  causedByLocalCommit : Boolean
[read-only] Contains true if this conflict resulted from commiting a local change to the remote destination, and false if it resulted from a pushed change conflicting with a local change.
Conflict
  clientObject : Object
[read-only] Returns the state of the client object (whose property was changed) at the time of the conflict.
Conflict
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  destination : String
[read-only] Returns the destination for the data service of the item involved in this conflict.
Conflict
 InheritederrorID : int
[read-only] Contains the reference number associated with the specific error message.
Error
 Inheritedmessage : String
Contains the message associated with the Error object.
Error
 Inheritedname : String
Contains the name of the Error object.
Error
  originalObject : Object
[read-only] Returns the state of the original client object before its properties were changed, as known at the time of the conflict.
Conflict
  propertyNames : Array
[read-only] Returns an Array of the names of the properties that were in conflict between the client change and the remote item state.
Conflict
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  resolved : Boolean
[read-only] Indicates whether this Conflict has been resolved (acceptClient() or acceptServer() has been called).
Conflict
  serverObject : Object
[read-only] Returns the value of server object whose property was to be changed.
Conflict
  serverObjectReferencedIds : Object
[read-only] If the serverObject has any properties with lazy="true", returns an Object that stores the referencedId Arrays for each lazily loaded property, using the property name as the lookup key value.
Conflict
Public Methods
 MethodDefined By
  
acceptClient():void
Requeues the current local changes and updates the property values such that a subsequent call to DataService.commit() should succeed, causing these changes to override the previous ones.
Conflict
  
acceptServer():void
Removes the conflicting local change and applies the property values found on Conflict.serverObject to the local item.
Conflict
 Inherited
getStackTrace():String
Returns the call stack for an error as a string at the time of the error's construction (for the debugger version of Flash Player and the AIR Debug Launcher (ADL) only; returns null if not using the debugger version of Flash Player or the ADL.
Error
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 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
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
  
toString():String
Returns a String representation of this Conflict object.
Conflict
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail
causeproperty
cause:DataMessage  [read-only]

Returns the DataMessage object that caused the conflict.


Implementation
    public function get cause():DataMessage
causedByLocalCommitproperty 
causedByLocalCommit:Boolean  [read-only]

Contains true if this conflict resulted from commiting a local change to the remote destination, and false if it resulted from a pushed change conflicting with a local change.


Implementation
    public function get causedByLocalCommit():Boolean
clientMessageproperty 
clientMessage:DataMessage  [read-write]


Implementation
    mx_internal function get clientMessage():DataMessage
    mx_internal function set clientMessage(value:DataMessage):void
clientObjectproperty 
clientObject:Object  [read-only]

Returns the state of the client object (whose property was changed) at the time of the conflict.


Implementation
    public function get clientObject():Object
concreteDataServiceproperty 
concreteDataService:ConcreteDataService  [read-only]


Implementation
    mx_internal function get concreteDataService():ConcreteDataService
destinationproperty 
destination:String  [read-only]

Returns the destination for the data service of the item involved in this conflict.


Implementation
    public function get destination():String
originalObjectproperty 
originalObject:Object  [read-only]

Returns the state of the original client object before its properties were changed, as known at the time of the conflict.


Implementation
    public function get originalObject():Object
propertyNamesproperty 
propertyNames:Array  [read-only]

Returns an Array of the names of the properties that were in conflict between the client change and the remote item state. All property names are String values and exist in the public namespace.


Implementation
    public function get propertyNames():Array
resolvedproperty 
resolved:Boolean  [read-only]

Indicates whether this Conflict has been resolved (acceptClient() or acceptServer() has been called).


Implementation
    public function get resolved():Boolean

See also

mx.data.Conflict.acceptServer()
mx.data.Conflict.acceptClient()
serverObjectproperty 
serverObject:Object  [read-only]

Returns the value of server object whose property was to be changed.


Implementation
    public function get serverObject():Object
serverObjectReferencedIdsproperty 
serverObjectReferencedIds:Object  [read-only]

If the serverObject has any properties with lazy="true", returns an Object that stores the referencedId Arrays for each lazily loaded property, using the property name as the lookup key value.


Implementation
    public function get serverObjectReferencedIds():Object
Method Detail
acceptClient()method
public function acceptClient():void

Requeues the current local changes and updates the property values such that a subsequent call to DataService.commit() should succeed, causing these changes to override the previous ones.


Example 
         private function conflictHandler(event:DataConflictEvent):void
         {
             if (acceptClientCheck.selected)
             {
                  event.conflict.acceptClient();
             }
             else
             {
                  event.conflict.acceptServer();
             }
         }
acceptServer()method 
public function acceptServer():void

Removes the conflicting local change and applies the property values found on Conflict.serverObject to the local item.


Example 
         private function conflictHandler(event:DataConflictEvent):void
         {
             if (acceptClientCheck.selected)
             {
                  event.conflict.acceptClient();
             }
             else
             {
                  event.conflict.acceptServer();
             }
         }
toString()method 
public function toString():String

Returns a String representation of this Conflict object.

Returns
String



© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Thu Jul 3 2008, 01:43 AM -07:00

 

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

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/common/langref/mx/data/Conflict.html