| Package | mx.data.mxml |
| Class | public class DataService |
| Inheritance | DataService  DataService DataManager 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 |
Note: The destination property must be set
before using a DataService object.
Show MXML Syntax
Hide MXML SyntaxThe <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
mx.data.DataService
mx.data.Conflicts
mx.data.Conflict
mx.data.ItemReference
mx.data.IManaged
mx.data.utils.Managed
mx.data.IChangeObject
mx.data.Conflicts
mx.data.Conflict
mx.data.ItemReference
mx.data.IManaged
mx.data.utils.Managed
mx.data.IChangeObject
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | adapter : DataServiceAdapter = null
An instance of a class that controls interaction with the server. | DataManager | |
| autoCommit : Boolean
Indicates whether 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
You can store the local cache of data and changes to disk. | DataManager | |
| autoSyncEnabled : Boolean
When true, fill(), createItem() and
getItem() requests return items that 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
DataManager instance. | DataManager | |
| conflicts : Conflicts [read-only]
Contains a Conflicts object, which is 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 | ||
| encryptLocalCache : Boolean
Indicates if offline storage should be encrypted For AIR
clients that use a SQL offline adapter. | DataManager | |
| fallBackToLocalFill : Boolean
This flag determines whether the application should query against the
local store when it is not connected. | DataManager | |
| hierarchicalEventsDefault : Boolean
Associations optionally list property change events on properties of
the associated instances. | DataManager | |
| ignoreCollectionUpdates : Boolean
Indicates if changes to managed collections should be ignored instead of
being communicated to the server on a commit. | 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
DataManager from association properties of other items. | DataManager | |
| isInitialized : Boolean [read-only]
Indicates whether the metadata associated with this DataManager instance
is initialized. | DataManager | |
| manualSync : ManualSyncConfiguration
Provides access to the ManualSyncConfiguration
instance for each DataManager instance. | DataManager | |
| maxFrequency : uint
Determines the maximum number of messages per second the DataManager instance
can receive. | DataManager | |
| mergeRequired : Boolean [read-only]
Indicates whether there are any pending changes that must be
merged. | DataManager | |
| offlineAdapter : DataServiceOfflineAdapter
Returns an object of type mx.data.DataServiceOfflineAdapter. | DataManager | |
| pageSize : int
Provides access to the current page size setting for all collections. | DataManager | |
| pagingEnabled : Boolean [read-only]
Indicates whether the remote destination is configured to allow paged
requests. | DataManager | |
| priority : int
The default message priority for the messages the DataManager instance sends. | DataManager | |
| requestTimeout : int
Provides access to the request timeout in seconds for an operation. | DataManager | |
| resetCollectionOnFill : Boolean
When the property is true, after the fill operation completes, a RESET event is
sent. | DataManager | |
| resubscribeAttempts : int
Controls the number of times a disconnected DataManager instance attempts to
resubscribe to its destination. | DataManager | |
| resubscribeInterval : int
Controls the delay, in milliseconds, between resubscribe attempts. | DataManager | |
| saveCacheRequired : 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 | |
| subscribed : Boolean [read-only]
Indicates if the DataManager instance is subscribed to the remote destination. | DataManager | |
| throwItemPendingErrors : 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
| Method | Defined By | ||
|---|---|---|---|
DataService(dest:String = null)
Constructs an instance of the DataService with the specified
destination. | DataService | ||
|
Clears any data stored to disk with a previous call to the
saveCache() method or when the autoSaveCache method was set to
true
| DataManager | |
|
Clears the data specified by the passed descriptor from the local store. | DataManager | |
|
Commits pending changes for all collections currently managed by
the DataStore instance associated with this DataManager instance. | DataManager | |
|
Indicates if there are pending changes for this particular object. | DataManager | |
|
Forces a connection attempt by this service to the remote destination. | DataManager | |
|
Calls a count method on the remote destination. | DataManager | |
|
Requests that the specified item be created in the remote store. | DataManager | |
|
Requests that the specified item be deleted from the remote store. | DataManager | |
|
Disconnects the DataManager instance's network connection. | DataManager | |
|
Executes a query with the provided name and arguments. | DataManager | |
|
Fills the specified ListCollectionView (collection) instance based
on the associated fill method of the destination. | DataManager | |
|
Fills the specified ListCollectionView (collection) instance based
on the associated fill method of the destination. | DataManager | |
|
Executes a query that returns a single item. | DataManager | |
|
Returns an ArrayCollection or a single managed object from the
the local store. | DataManager | |
| getCacheDescriptors(view:ListCollectionView, options:uint = 0, item:Object = null):mx.rpc:AsyncToken
Fills the specified ListCollectionView (collection) instance with
CacheDataDescriptor instances. | DataManager | |
|
Fills the specified ListCollectionView (collection) instance
with all cache identifiers previously used in the application. | DataManager | |
|
Makes an asynchronous request for an item matching the
specified identity. | DataManager | |
|
Looks up the supplied item with the given identity. | DataManager | |
|
Returns page information for the specified collection. | DataManager | |
|
Returns the pending operation in the message cache for the specified
item. | DataManager | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Forces initialization of the DataStore. | DataManager | |
|
Returns true if the passed collection is managed by this service. | DataManager | |
|
Returns true if the passed collection is using paging features. | DataManager | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Returns true if the supplied range of items is all paged in. | DataManager | |
|
Fills the specified ListCollectionView based
on the associated <fill-method> elements based on the data from the
local store. | DataManager | |
|
Logs the user out of the destination for the DataService. | DataService | |
|
Merges any pending updates into the managed set of objects. | DataManager | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Refreshes all data managed by this DataManager instance. | DataManager | |
|
Refreshes a collection previously filled with the fill method or managed as
a managed association. | DataManager | |
|
Releases all managed collections and items for the DataManager instance. | DataManager | |
| releaseCollection(view:ListCollectionView, clear:Boolean = false, copyStillManagedItems:Boolean = true):void
Releases any item within the specified collection from management by
this DataManager instance. | DataManager | |
| releaseItem(item:IManaged, copyStillManagedItems:Boolean = true, enableStillManagedCheck:Boolean = true):IManaged
Releases the specified item from management by this DataManager instance. | DataManager | |
|
Releases a range of items in the collection. | DataManager | |
|
Releases the value for a single-valued association. | DataManager | |
|
Reverts any uncommitted changes to the specified item. | DataManager | |
|
Reverts the changes for any item contained in the specified collection which should
be managed by this DataManager instance. | DataManager | |
|
This method saves the current state of the DataManager instance's cache. | DataManager | |
|
Indicates if there are pending changes for this particular object
that are not saved to the local cache. | DataManager | |
|
Sets the credentials for this DataService destination. | DataService | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets the credentials for the third party of this DataService destination. | DataService | |
|
Obtains the changed items for all previously executed fills on this data service
(data manager). | DataManager | |
| [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 | |
|
Obtains the changed items that have changed on the server since the
previous time a fill or synchronizeFill was invoked. | DataManager | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Triggers an update for the specified item. | DataManager | |
|
Returns the primitive value of the specified object. | Object | |
Protected Methods
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):voidConstructor 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.
Parametersdest:String (default = null) |
Thu Dec 6 2018, 01:12 PM -08:00