mx.data.DataStore (Flex™ 2.0.1 Language Reference)

	Property	Defined by
		autoCommit : Boolean If set to `true`, operations that modify the state managed by the DataService are committed immediately.	DataStore
		autoMerge : Boolean If set to `false`, when changes are pushed from the server to the client they are not immediately applied.	DataStore
		commitRequired : Boolean [read-only] Indicates if there are pending updates that must be committed.	DataStore
		conflicts : Conflicts [read-only] Returns a list of conflicts for all managed items.	DataStore
		connected : Boolean [read-only] Indicates whether the DataStore is connected.	DataStore
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		mergeRequired : Boolean [read-only] Indicates if there are any pending changes that must be merged.	DataStore
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		requestTimeout : int Provides access to the request timeout in seconds for an operation.	DataStore

	Method	Defined by
		DataStore(destination:String, useTransactions:Boolean) Normally, a DataStore is created automatically for you but you can create your own DataStore and assign it to the `dataStore` property of a DataService.	DataStore
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		commit():AsyncToken Commits any pending changes for all collections currently managed by this DataService.	DataStore
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		merge():void Merges any pending updates into the managed set of objects.	DataStore
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		revertChanges():Boolean Reverts all pending (uncommitted) changes for all DataServices managed by this DataStore.	DataStore
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Summary	Defined by
activate	Dispatched when Flash Player gains operating system focus and becomes active.	EventDispatcher
conflict	Dispatched when a conflict is detected between either pending changes on this client and changes submitted by another client, or when changes submitted by this client result detect a conflict error at the remote destination.	DataStore
deactivate	Dispatched when Flash Player loses operating system focus and is becoming inactive.	EventDispatcher
fault	The `FaultEvent.FAULT` event is dispatched when the commit call returns an error.	DataStore
result	The `ResultEvent.RESULT` event is dispatched when the commit call successfully returns.	DataStore

autoCommit:Boolean [read-write]

If set to true, operations that modify the state managed by the DataService are committed immediately. If set to false, you must explicitly call the commit() method to send the changes to the server.

Implementation
public function get autoCommit():Boolean
public function set autoCommit(value:Boolean):void

autoMerge:Boolean [read-write]

If set to false, when changes are pushed from the server to the client they are not immediately applied. Instead, the mergeRequired property is set to true. You can listen for change events on this property to be notified of when a merge needs to be applied. To merge changes, you call the merge() method and all changes are applied. You are not able to commit any changes when there are any changes that must be merged.

Implementation
public function get autoMerge():Boolean
public function set autoMerge(value:Boolean):void

commitRequired:Boolean [read-only]

Indicates if there are pending updates that must be committed.

This property can be used as the source for data binding.

Implementation
public function get commitRequired():Boolean

conflicts:Conflicts [read-only]

Returns a list of conflicts for all managed items.

This property can be used as the source for data binding.

Implementation
public function get conflicts():Conflicts

connected:Boolean [read-only]

Indicates whether the DataStore is connected.

Implementation
public function get connected():Boolean

mergeRequired:Boolean [read-only]

Indicates if there are any pending changes that must be merged.

This property can be used as the source for data binding.

Implementation
public function get mergeRequired():Boolean

requestTimeout:int [read-write]

Provides access to the request timeout in seconds for an operation. A value less than or equal to zero prevents request timeout.

Implementation
public function get requestTimeout():int
public function set requestTimeout(value:int):void

public function DataStore(destination:String, useTransactions:Boolean)

Normally, a DataStore is created automatically for you but you can create your own DataStore and assign it to the dataStore property of a DataService. To do this, you must ensure all data services that share the same data store use the same channel set and have the same value of the use-transactions configuration setting. Use this constructor to create a DataStore where the destination parameter contains the destination of one of the DataServices using this data store. This is just used to look up the channel set. You also should provide the value for the use-transactions flag for this data store.

Parameters

	`destination:String`

	`useTransactions:Boolean`

public function commit():AsyncToken

Commits any pending changes for all collections currently managed by this DataService. When the autoCommit property is true, transactions are not be used. To use transactions, set the autoCommit property to false and call this method directly.

Returns

AsyncToken — Object that is returned in call property of either the ResultEvent.RESULT or in the FaultEvent.FAULT. Custom data can be attached to this object and inspected later during the event handling phase.

public function merge():void

Merges any pending updates into the managed set of objects. The process of merging changes can detect conflicts.

public function revertChanges():Boolean

Reverts all pending (uncommitted) changes for all DataServices managed by this DataStore.

Returns

Boolean — true if any changes were reverted.

Event object type: mx.data.events.DataConflictEvent
DataConflictEvent.type property = mx.data.events.DataConflictEvent.CONFLICT

Dispatched when a conflict is detected between either pending changes on this client and changes submitted by another client, or when changes submitted by this client result detect a conflict error at the remote destination. The DataStore dispatches conflict events for all destinations which share the DataStore, or you can listen for conflict events for a specific type on a DataService. Use the DataStore when you have an object with associations as in that case, you may need to resolve conflicts in a specific order to maintain integrity of those associations.

The CONFLICT event type.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`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`.
`conflict`	The Conflict object that holds the conflict that occurred.
`message`	The Message associated with this event.
`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.

Event object type: mx.rpc.events.FaultEvent
FaultEvent.type property = mx.rpc.events.FaultEvent.FAULT

The FaultEvent.FAULT event is dispatched when the commit call returns an error.

The FAULT event type.

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 contains the details of what caused this event.
`message`	The Message associated with this event.
`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.
`token`	The token that represents the call to the method. Used in the asynchronous completion token pattern.

Event object type: mx.rpc.events.ResultEvent
ResultEvent.type property = mx.rpc.events.ResultEvent.RESULT

The ResultEvent.RESULT event is dispatched when the commit call successfully returns.

The RESULT event type.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	true, preventDefault() from the associated token's responder.result 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`.
`message`	The Message associated with this event.
`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.
`result`	Result that the RPC call returns.
`token`	The token that represents the indiviudal call to the method. Used in the asynchronous completion token pattern.

Adobe^® Flex™ 2.0.1 Language Reference		All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
Class DataStore	Properties \| Methods \| Events

Package	mx.data
Class	public class DataStore
Inheritance	DataStore EventDispatcher Object