ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.data.mxml 

DataService  - AS3 ADEP Data Services

Packagemx.data.mxml
Classpublic class DataService
InheritanceDataService Inheritance DataService Inheritance DataManager Inheritance Object
Implements IMXMLObject

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

The DataService class provides the top-level client-side functionality for the LiveCycle Data Services Data Management Service. This is an MXML-specific subclass of mx.data.DataService that allows binding to the properties of a DataService instance.

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

MXML SyntaxexpandedHide 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."
 />
 

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedadapter : DataServiceAdapter = null
An instance of a class that controls interaction with the server.
DataManager
 InheritedautoCommit : Boolean
Indicates whether changes to the local cache are automatically committed.
DataManager
 InheritedautoConnect : Boolean
Indicates if this service should attempt to connect for any operations that require a connection.
DataManager
 InheritedautoMerge : Boolean
If set to false, when changes are pushed from the remote destination to the client they are not immediately applied.
DataManager
 InheritedautoSaveCache : Boolean
You can store the local cache of data and changes to disk.
DataManager
 InheritedautoSyncEnabled : Boolean
When true, fill(), createItem() and getItem() requests return items that listen for updates made to these items from the remote destination.
DataManager
 InheritedcacheID : String
Provides access to the cache identifier for this service.
DataManager
 InheritedchannelSet : ChannelSet
Provides access to the ChannelSet used by the service.
DataService
 InheritedcommitRequired : Boolean
[read-only] Indicates if there are changes that have not been committed and the commit() method should be called.
DataManager
 InheritedconflictDetector : ConflictDetector
Provides access to the current implementation being used to detect conflicts for remote operations pushed to this DataManager instance.
DataManager
 Inheritedconflicts : Conflicts
[read-only] Contains a Conflicts object, which is an ArrayList of Conflict instances.
DataManager
 Inheritedconnected : Boolean
[read-only] Indicates if the DataService is connected to the remote destination.
DataManager
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheriteddataStore : DataStore
Contains an object of type mx.data.DataStore.
DataManager
 InheriteddeleteItemOnRemoveFromFill : 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
 InheritedencryptLocalCache : Boolean
Indicates if offline storage should be encrypted For AIR clients that use a SQL offline adapter.
DataManager
 InheritedfallBackToLocalFill : Boolean
This flag determines whether the application should query against the local store when it is not connected.
DataManager
 InheritedhierarchicalEventsDefault : Boolean
Associations optionally list property change events on properties of the associated instances.
DataManager
 InheritedignoreCollectionUpdates : Boolean
Indicates if changes to managed collections should be ignored instead of being communicated to the server on a commit.
DataManager
 InheritedindexReferences : 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 DataManager from association properties of other items.
DataManager
 InheritedisInitialized : Boolean
[read-only] Indicates whether the metadata associated with this DataManager instance is initialized.
DataManager
 InheritedmanualSync : ManualSyncConfiguration
Provides access to the ManualSyncConfiguration instance for each DataManager instance.
DataManager
 InheritedmaxFrequency : uint
Determines the maximum number of messages per second the DataManager instance can receive.
DataManager
 InheritedmergeRequired : Boolean
[read-only] Indicates whether there are any pending changes that must be merged.
DataManager
 InheritedofflineAdapter : DataServiceOfflineAdapter
Returns an object of type mx.data.DataServiceOfflineAdapter.
DataManager
 InheritedpageSize : int
Provides access to the current page size setting for all collections.
DataManager
 InheritedpagingEnabled : Boolean
[read-only] Indicates whether the remote destination is configured to allow paged requests.
DataManager
 Inheritedpriority : int
The default message priority for the messages the DataManager instance sends.
DataManager
 InheritedrequestTimeout : int
Provides access to the request timeout in seconds for an operation.
DataManager
 InheritedresetCollectionOnFill : Boolean
When the property is true, after the fill operation completes, a RESET event is sent.
DataManager
 InheritedresubscribeAttempts : int
Controls the number of times a disconnected DataManager instance attempts to resubscribe to its destination.
DataManager
 InheritedresubscribeInterval : int
Controls the delay, in milliseconds, between resubscribe attempts.
DataManager
 InheritedsaveCacheRequired : Boolean
[read-only] Indicates if there are changes that have not been saved to the local cache and the saveCache() method should be called.
DataManager
 Inheritedsubscribed : Boolean
[read-only] Indicates if the DataManager instance is subscribed to the remote destination.
DataManager
 InheritedthrowItemPendingErrors : Boolean
Set this property to false if you want to suppress item pending errors when lazily fetched or unpaged data is accessed.
DataManager
Public Methods
 MethodDefined By
  
DataService(dest:String = null)
Constructs an instance of the DataService with the specified destination.
DataService
 Inherited
Clears any data stored to disk with a previous call to the saveCache() method or when the autoSaveCache method was set to true
DataManager
 Inherited
Clears the data specified by the passed descriptor from the local store.
DataManager
 Inherited
commit(itemsOrCollections:Array = null, cascadeCommit:Boolean = false):mx.rpc:AsyncToken
Commits pending changes for all collections currently managed by the DataStore instance associated with this DataManager instance.
DataManager
 Inherited
Indicates if there are pending changes for this particular object.
DataManager
 Inherited
Forces a connection attempt by this service to the remote destination.
DataManager
 Inherited
Calls a count method on the remote destination.
DataManager
 Inherited
Requests that the specified item be created in the remote store.
DataManager
 Inherited
Requests that the specified item be deleted from the remote store.
DataManager
 Inherited
Disconnects the DataManager instance's network connection.
DataManager
 Inherited
executeQuery(queryName:String, propertySpecifier:PropertySpecifier, ... args):mx.rpc:AsyncToken
Executes a query with the provided name and arguments.
DataManager
 Inherited
Fills the specified ListCollectionView (collection) instance based on the associated fill method of the destination.
DataManager
 Inherited
Fills the specified ListCollectionView (collection) instance based on the associated fill method of the destination.
DataManager
 Inherited
findItem(queryName:String, propertySpecifier:PropertySpecifier, ... args):mx.rpc:AsyncToken
Executes a query that returns a single item.
DataManager
 Inherited
Returns an ArrayCollection or a single managed object from the the local store.
DataManager
 Inherited
Fills the specified ListCollectionView (collection) instance with CacheDataDescriptor instances.
DataManager
 Inherited
Fills the specified ListCollectionView (collection) instance with all cache identifiers previously used in the application.
DataManager
 Inherited
getItem(identity:Object, defaultValue:Object = null):ItemReference
Makes an asynchronous request for an item matching the specified identity.
DataManager
 Inherited
Looks up the supplied item with the given identity.
DataManager
 Inherited
Returns page information for the specified collection.
DataManager
 Inherited
Returns the pending operation in the message cache for the specified item.
DataManager
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Forces initialization of the DataStore.
DataManager
 Inherited
Returns true if the passed collection is managed by this service.
DataManager
 Inherited
Returns true if the passed collection is using paging features.
DataManager
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
isRangeResident(view:ListCollectionView, startIndex:int, numberOfItems:int):Boolean
Returns true if the supplied range of items is all paged in.
DataManager
 Inherited
Fills the specified ListCollectionView based on the associated <fill-method> elements based on the data from the local store.
DataManager
 Inherited
Logs the user out of the destination for the DataService.
DataService
 Inherited
Merges any pending updates into the managed set of objects.
DataManager
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Refreshes all data managed by this DataManager instance.
DataManager
 Inherited
Refreshes a collection previously filled with the fill method or managed as a managed association.
DataManager
 Inherited
release(clear:Boolean = true, copyStillManagedItems:Boolean = true):void
Releases all managed collections and items for the DataManager instance.
DataManager
 Inherited
releaseCollection(view:ListCollectionView, clear:Boolean = false, copyStillManagedItems:Boolean = true):void
Releases any item within the specified collection from management by this DataManager instance.
DataManager
 Inherited
releaseItem(item:IManaged, copyStillManagedItems:Boolean = true, enableStillManagedCheck:Boolean = true):IManaged
Releases the specified item from management by this DataManager instance.
DataManager
 Inherited
releaseItemsFromCollection(collection:ListCollectionView, startIndex:int, numberOfItems:int):int
Releases a range of items in the collection.
DataManager
 Inherited
Releases the value for a single-valued association.
DataManager
 Inherited
Reverts any uncommitted changes to the specified item.
DataManager
 Inherited
Reverts the changes for any item contained in the specified collection which should be managed by this DataManager instance.
DataManager
 Inherited
This method saves the current state of the DataManager instance's cache.
DataManager
 Inherited
Indicates if there are pending changes for this particular object that are not saved to the local cache.
DataManager
 Inherited
setCredentials(username:String, password:String):void
Sets the credentials for this DataService destination.
DataService
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Sets the credentials for the third party of this DataService destination.
DataService
 Inherited
Obtains the changed items for all previously executed fills on this data service (data manager).
DataManager
 Inherited
[static] A convenience method to allow the synchronization of all local data: a synchronizeAllFills() is invoked on each data service (data manager) specified such that the final result token is completed only when all the individual synchronizeAllFills() calls are completed.
DataManager
 Inherited
Obtains the changed items that have changed on the server since the previous time a fill or synchronizeFill was invoked.
DataManager
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
updateItem(item:Object, origItem:Object = null, changes:Array = null):mx.rpc:AsyncToken
Triggers an update for the specified item.
DataManager
 Inherited
Returns the primitive value of the specified object.
Object
Protected Methods
 MethodDefined By
 Inherited
Queues a fault if this data manager has not yet been initialized.
DataManager
Events
 Event Summary Defined By
 InheritedThe DataConflictEvent.CONFLICT event is dispatched when a conflict is detected between pending local changes and changes submitted by another client, or when changes submitted by this client conflict with those in the remote destination.DataService
 InheritedThe DataServiceFaultEvent.FAULT event is dispatched when a service call fails due to an error.DataService
 InheritedThe MessageEvent.MESSAGE event is dispatched when the remote destination pushes a notification of a data operation.DataService
 InheritedThe PropertyChangeEvent.PROPERTY_CHANGE event is dispatched when a property of this service changes.DataService
 InheritedThe 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: Adobe Digital Enterprise Platform Data Services for Java EE 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: Adobe Digital Enterprise Platform Data Services for Java EE 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.