mx.data.mxml.DataService - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.data.mxml
Class	public class DataService
Inheritance	DataService DataService DataManager Object
Implements	IMXMLObject

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

The DataService class provides the top-level functionality for distributed data. This is an MXML-specific subclass of mx.data.DataService that allows binding to the properties of a DataService.

Note: The destination property must be set before using a DataService object.

MXML Syntax expanded

Hide MXML Syntax

The <mx:DataService> tag accepts the following tag attributes:

  <mx:DataService
   Properties
   autoCommit="true"
   autoMerge="true"
   autoSaveCache="false"
   autoSyncEnabled="true"
   conflictDetector="No default."
   dataStore="No default."
   destination="No default."
   pageSize="No default."
   id="No default."
 
   Events
   conflict="No default."
   fault="No default."
   message="No default."
   propertyChange="No default."
   result="No default."
 />

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		adapter : DataServiceAdapter = null An instance of a class which controls interaction with the server.	DataManager
		autoCommit : Boolean Indicates if changes to the local cache are automatically committed.	DataManager
		autoConnect : Boolean Indicates if this service should attempt to connect for any operations that require a connection.	DataManager
		autoMerge : Boolean If set to false, when changes are pushed from the remote destination to the client they are not immediately applied.	DataManager
		autoSaveCache : Boolean The local cache of data and changes can be stored to disk.	DataManager
		autoSyncEnabled : Boolean When true, fill(), createItem() and getItem() requests return items which listen for updates made to these items from the remote destination.	DataManager
		cacheID : String Provides access to the cache identifier for this service.	DataManager
		channelSet : ChannelSet Provides access to the ChannelSet used by the service.	DataService
		commitRequired : Boolean [read-only] Indicates if there are changes that have not been committed and the commit() method should be called.	DataManager
		conflictDetector : ConflictDetector Provides access to the current implementation being used to detect conflicts for remote operations pushed to this DataService.	DataManager
		conflicts : Conflicts [read-only] Contains a Conflicts object, an ArrayList of Conflict instances.	DataManager
		connected : Boolean [read-only] Indicates if the DataService is connected to the remote destination.	DataManager
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		dataStore : DataStore Contains an object of type mx.data.DataStore.	DataManager
		deleteItemOnRemoveFromFill : Boolean By default when you call the removeItemAt() method on a managed filled collection, it issues a delete item call to the server to physically remove the item.	DataManager
		destination : String [override] Indicates which remote destination this service is associated with.	DataService
		hierarchicalEventsDefault : Boolean Associations optionally list for property change events on properties of the associated instances.	DataManager
		indexReferences : Boolean To tune the speed of your application, set this property to false if you have a small number of fills or references to items managed by this data service from association properties of other items.	DataManager
		isInitialized : Boolean [read-only] Indicates if the metadata associated with this service is initialized.	DataManager
		manualSync : ManualSyncConfiguration The manualSync property provides access to the ManualSyncConfiguration instance for each data service.	DataManager
		maxFrequency : uint Determines the maximum number of messages per second the DataManager wants to receive.	DataManager
		mergeRequired : Boolean [read-only] Indicates if there are any pending changes that must be merged.	DataManager
		pageSize : int Provides access to the current page size setting for all collections.	DataManager
		pagingEnabled : Boolean [read-only] Indicates if the remote destination is configured to allow paged requests.	DataManager
		priority : int The default message priority for the messages sent by the data service.	DataManager
		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.	DataManager
		resetCollectionOnFill : Boolean When true, after the fill operation completes, a RESET event is sent.	DataManager
		resubscribeAttempts : int Controls the number of times a disconnected data service will attempt to resubscribe.	DataManager
		resubscribeInterval : int Controls the delay, in milliseconds, between resubscribe attempts.	DataManager
		subscribed : Boolean [read-only] Indicates if the DataService is subscribed to the remote destination.	DataManager
		throwItemPendingErrors : Boolean Set this property to false if you want to suppress the throwing of item pending errors when lazily fetched or unpaged data is accessed.	DataManager

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		DataService(dest:String = null) Constructs an instance of the DataService with the specified destination.	DataService
		clearCache(value:Object = null):mx.rpc:AsyncToken Clears any data stored to disk with a previous call to saveCache() or when autoSaveCache was set to true	DataManager
		clearCacheData(descriptor:CacheDataDescriptor):mx.rpc:AsyncToken Clears the data specified by the passed descriptor from the local store.	DataManager
		commit(itemsOrCollections:Array = null, cascadeCommit:Boolean = false):mx.rpc:AsyncToken Commits pending changes for all collections currently managed by the DataStore associated with this data service.	DataManager
		connect():mx.rpc:AsyncToken Forces a connection attempt by this service to the remote destination.	DataManager
		count(... args):mx.rpc:AsyncToken Calls a count method on the remote destination.	DataManager
		createItem(item:Object):ItemReference Requests that the specified item be created in the remote store.	DataManager
		deleteItem(item:Object):mx.rpc:AsyncToken Requests that the specified item be deleted from the remote store.	DataManager
		disconnect():void Disconnects the DataService's network connection.	DataManager
		executeQuery(queryName:String, propertySpecifier:PropertySpecifier, ... args):mx.rpc:AsyncToken Executes a query with the provided name and arguments.	DataManager
		fill(value:ListCollectionView, ... args):mx.rpc:AsyncToken Fills the specified ListCollectionView based on the associated fill method of the destination.	DataManager
		fillSubset(value:ListCollectionView, ps:PropertySpecifier, ... args):mx.rpc:AsyncToken Fills the specified ListCollectionView based on the associated fill method of the destination.	DataManager
		findItem(queryName:String, propertySpecifier:PropertySpecifier, ... args):mx.rpc:AsyncToken Executes a query which returns a single item.	DataManager
		getCacheData(descriptor:CacheDataDescriptor):mx.rpc:AsyncToken Returns an ArrayCollection or a single managed object (SMO) from the the local store.	DataManager
		getCacheDescriptors(view:ListCollectionView, options:uint = 0, item:Object = null):mx.rpc:AsyncToken This method will fill the specified ListCollectionView with CacheDataDescriptor(s).	DataManager
		getCacheIDs(view:ListCollectionView):mx.rpc:AsyncToken This method will fill the specified ListCollectionView with all cache identifiers previously used in the application.	DataManager
		getItem(identity:Object, defaultValue:Object = null):ItemReference Makes an asynchronous request for an item matching the specified identity.	DataManager
		getLocalItem(identity:Object):Object Looks up the supplied item with the given identity.	DataManager
		getPageInformation(view:ListCollectionView):PageInformation Returns page information for the specified collection.	DataManager
		getPendingOperation(item:Object):uint Returns the pending operation in the message cache for the specified item.	DataManager
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		initialize():mx.rpc:AsyncToken Forces initialization of the DataStore.	DataManager
		isCollectionManaged(view:ListCollectionView):Boolean Returns true if the passed collection is managed by this service.	DataManager
		isCollectionPaged(view:ListCollectionView):Boolean Returns true if the passed collection is using paging features.	DataManager
		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
		isRangeResident(view:ListCollectionView, startIndex:int, numberOfItems:int):Boolean Returns true if the supplied range of items is all paged in.	DataManager
		logout():void Logs the user out of the destination for the DataService.	DataService
		merge():void Merges any pending updates into the managed set of objects.	DataManager
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		refresh():mx.rpc:AsyncToken Refreshes all data managed by this data service.	DataManager
		refreshCollection(value:ListCollectionView):mx.rpc:AsyncToken Refreshes an array collection previously filled with the fill method or managed as a managed association.	DataManager
		release(clear:Boolean = true, copyStillManagedItems:Boolean = true):void Releases all managed collections and items for the DataService.	DataManager
		releaseCollection(view:ListCollectionView, clear:Boolean = false, copyStillManagedItems:Boolean = true):void Releases any item within the specified collection from management by this service.	DataManager
		releaseItem(item:IManaged, copyStillManagedItems:Boolean = true, enableStillManagedCheck:Boolean = true):IManaged Releases the specified item from management by this service.	DataManager
		releaseItemsFromCollection(collection:ListCollectionView, startIndex:int, numberOfItems:int):int Releases a range of items in the collection.	DataManager
		releaseReference(item:Object, propName:String):Boolean Releases the value for a single-valued association.	DataManager
		revertChanges(item:IManaged = null):Boolean Reverts any uncommitted changes to the specified item.	DataManager
		revertChangesForCollection(collection:ListCollectionView = null):Boolean Reverts the changes for any item contained in the specified collection which should be managed by this data service.	DataManager
		saveCache(value:Object = null):mx.rpc:AsyncToken This method will save the current state of the DataService cache.	DataManager
		setCredentials(username:String, password:String):void Sets the credentials for this DataService destination.	DataService
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setRemoteCredentials(username:String, password:String):void Sets the credentials for the third party of this DataService destination.	DataService
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		updateItem(item:Object, origItem:Object = null, changes:Array = null):mx.rpc:AsyncToken Triggers an update for the specified item.	DataManager
		valueOf():Object Returns the primitive value of the specified object.	Object

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		checkImplementation():void Queues a fault if this data manager has not yet been initialized.	DataManager

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
conflict	The DataConflictEvent.CONFLICT event is dispatched when a conflict is detected between either pending local changes and changes submitted by another client, or when changes submitted by this client are conflicting with those in the remote destination.	DataService
fault	The DataServiceFaultEvent.FAULT event is dispatched when a service call fails due to an error.	DataService
message	The MessageEvent.MESSAGE event is dispatched when the remote destination pushes a notification of a data operation.	DataService
propertyChange	The PropertyChangeEvent.PROPERTY_CHANGE event is dispatched when a property of this service changes.	DataService
result	The ResultEvent.RESULT event is dispatched when a service call successfully returns.	DataService

Property Detail

destination

property

destination:String[override]

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Indicates which remote destination this service is associated with.

Implementation
override public function get destination():String
override public function set destination(value:String):void

Constructor Detail

DataService

()

Constructor

public function DataService(dest:String = null)

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructs an instance of the DataService with the specified destination. The destination must be a reference to a destination configured in the services-config.xml file.

Parameters

dest:String (default = null) — String that contains the name of the remote destination this service will connect to.