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

DataServiceOfflineAdapter  - AS3 ADEP Data Services

Packagemx.data
Classpublic class DataServiceOfflineAdapter
InheritanceDataServiceOfflineAdapter Inheritance Object
Subclasses SQLiteOfflineAdapter

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

Provides persistence for a DataManager's offline cached items.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Protected Properties
 PropertyDefined By
  destination : String
[read-only] Indicates the destination associated with this offline adapter.
DataServiceOfflineAdapter
Public Methods
 MethodDefined By
  
Constructor.
DataServiceOfflineAdapter
  
Adds the specified offline item to the localStore.
DataServiceOfflineAdapter
  
Begins a transaction on the localStore.
DataServiceOfflineAdapter
  
Closes the localStore associated with this adapter.
DataServiceOfflineAdapter
  
commit(dispatcher:IEventDispatcher = null, token:mx.rpc:AsyncToken = null, faultsOnly:Boolean = false):void
Commits any current changes to the local store.
DataServiceOfflineAdapter
  
Connect to the specified cache.
DataServiceOfflineAdapter
  
Deletes the specified offine item with the matching uid from the local store.
DataServiceOfflineAdapter
  
Deletes the specified set of offine items with the matching uids from the local store.
DataServiceOfflineAdapter
  
executeOfflineQuery(propSpecifier:PropertySpecifier, args:Array, startIndex:int, numItems:int):mx.rpc:AsyncToken
Execute a query against the offline cache.
DataServiceOfflineAdapter
  
Returns the current fills that have been cached in the local store.
DataServiceOfflineAdapter
  
Get the ids of the associated items for a given item uid and an association property.
DataServiceOfflineAdapter
  
Restores all the items specified using the uid array specified for a given destination.
DataServiceOfflineAdapter
  
Restores the message cache from the offline store.
DataServiceOfflineAdapter
 Inherited
Indicates whether an object has a specified property defined.
Object
  
Initialize the cacheId store.
DataServiceOfflineAdapter
  
initializeOfflineMetadata(metadata:Metadata):void
Initializes the offline cache.
DataServiceOfflineAdapter
  
Returns true if the local store is "connected"; for example, if the local database is open.
DataServiceOfflineAdapter
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
  
Returns true if custom queries are supported with this adapter.
DataServiceOfflineAdapter
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
Restores queries.
DataServiceOfflineAdapter
  
Look up the metadata for a given destination.
DataServiceOfflineAdapter
  
Rolls back any current changes on the local store.
DataServiceOfflineAdapter
  
Add/Remove all the items specified within the dictionary.
DataServiceOfflineAdapter
  
saveMessageCache(messageCache:DataMessageCache, unmergedMessages:Array):void
Saves the pending uncommitted messages and unmerges messages.
DataServiceOfflineAdapter
  
Save the meta data configuration for a given destination.
DataServiceOfflineAdapter
  
saveQuery(queryParams:Object, data:Object):void
Saves queries to be replayed offline later.
DataServiceOfflineAdapter
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 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
  
updateOfflineItem(item:Object, propChangeList:Array):void
Updates the specified properties of the specified offline item in the local store.
DataServiceOfflineAdapter
  
It is used to update the items that were modified to the local store.
DataServiceOfflineAdapter
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

destination

property
destination:String  [read-only]

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

Indicates the destination associated with this offline adapter.



Implementation
    protected function get destination():String
Constructor Detail

DataServiceOfflineAdapter

()Constructor
public function DataServiceOfflineAdapter()

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

Constructor.

Method Detail

addOfflineItem

()method
public function addOfflineItem(item:Object):void

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

Adds the specified offline item to the localStore.

Parameters

item:Object — The item to save to the local store.

beginTransaction

()method 
public function beginTransaction():void

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

Begins a transaction on the localStore.

close

()method 
public function close():void

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

Closes the localStore associated with this adapter.

commit

()method 
public function commit(dispatcher:IEventDispatcher = null, token:mx.rpc:AsyncToken = null, faultsOnly:Boolean = false):void

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

Commits any current changes to the local store.

Parameters

dispatcher:IEventDispatcher (default = null) — where to send success or fail events.
 
token:mx.rpc:AsyncToken (default = null) — the AsyncToken to use for any events.
 
faultsOnly:Boolean (default = false) — Send only fault events. Success events are not propagated.

connect

()method 
public function connect(cacheID:String):mx.rpc:AsyncToken

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

Connect to the specified cache.

Parameters

cacheID:String — the identifier of the cache to connect to.

Returns
mx.rpc:AsyncToken — AsyncToken You can use this token to register one or more callback functions to receive result or fault events from this operation.

deleteOfflineItem

()method 
public function deleteOfflineItem(uid:String):void

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

Deletes the specified offine item with the matching uid from the local store.

Parameters

uid:String — the uid of the item to delete.

deleteOfflineItems

()method 
public function deleteOfflineItems(uidArray:Array):void

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

Deletes the specified set of offine items with the matching uids from the local store.

Parameters

uidArray:Array — array of uids of items to delete.

executeOfflineQuery

()method 
public function executeOfflineQuery(propSpecifier:PropertySpecifier, args:Array, startIndex:int, numItems:int):mx.rpc:AsyncToken

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

Execute a query against the offline cache. Supported only for SQLLite implementations.

Parameters

propSpecifier:PropertySpecifier — PropertySpecifier to determine the subset of properties to be returned.
 
args:Array — the query parameters.
 
startIndex:int — start index for a paged query
 
numItems:int — number of items to retrieve for a paged query or -1 to retrieve all.

Returns
mx.rpc:AsyncToken — AsyncToken You can use this token to register one or more callback functions to receive result or fault events from this operation.

getFillList

()method 
public function getFillList():Array

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

Returns the current fills that have been cached in the local store.

Returns
Array — an array of fills that are cached.

getItemReferenceIds

()method 
public function getItemReferenceIds(uid:String, propName:String):Array

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

Get the ids of the associated items for a given item uid and an association property. Supported only for SQLLite implementations.

Parameters

uid:String — the uid of the item owning the association.
 
propName:String — the association property name.

Returns
Array — an array of ids for referenced items of the association.

getItems

()method 
public function getItems(uid:Array):Dictionary

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

Restores all the items specified using the uid array specified for a given destination.

Parameters

uid:Array — an array of uids to fetch

Returns
Dictionary — a map of uid to items

getMessageCache

()method 
public final function getMessageCache():Object

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

Restores the message cache from the offline store. The subclasses cannot override this functionality.

Returns
Object — the message cache

initializeCacheStore

()method 
public final function initializeCacheStore():void

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

Initialize the cacheId store. The cacheId store will be created the first time the application is initialized or prepopulated if schema is create at design time.

initializeOfflineMetadata

()method 
public function initializeOfflineMetadata(metadata:Metadata):void

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

Initializes the offline cache. Supported only for SQLLite implementations.

Parameters

metadata:Metadata — the metadata describing the destination.

isConnected

()method 
public function isConnected():Boolean

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

Returns true if the local store is "connected"; for example, if the local database is open.

Returns
Boolean — true if local store is connected.

isQuerySupported

()method 
public function isQuerySupported():Boolean

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

Returns true if custom queries are supported with this adapter. If false, then the LiveCycle Data Services 3.0 "BLOB" behavior is in place. If true, then the SQLite "property per column" behavior is in place.

Returns
Boolean — true if the adapter supports arbitrary queries against cached data.

restoreQuery

()method 
public function restoreQuery(queryParams:Object):Object

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

Restores queries.

Parameters

queryParams:Object — the query parameters for the query

Returns
Object — the descriptor of the query

retrieveMetaData

()method 
public function retrieveMetaData():Object

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

Look up the metadata for a given destination.

Returns
Object — the metadata object

rollback

()method 
public function rollback():void

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

Rolls back any current changes on the local store.

saveItems

()method 
public function saveItems(items:Array):void

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

Add/Remove all the items specified within the dictionary. If the dictionary contains the managed object, then it is persisted to the local store. If it contains the UID as the key, then the item is removed from the store.

Parameters

items:Array — an array of items to save

saveMessageCache

()method 
public final function saveMessageCache(messageCache:DataMessageCache, unmergedMessages:Array):void

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

Saves the pending uncommitted messages and unmerges messages. This is no need for subclasses to provide their own custom implementation of persisting the message cache and hence this cannot be overridden.

Parameters

messageCache:DataMessageCache — the message cache
 
unmergedMessages:Array — an array of unmerged messages

saveMetaData

()method 
public function saveMetaData(metadata:Object):void

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

Save the meta data configuration for a given destination.

Parameters

metadata:Object — the metadata to save

saveQuery

()method 
public function saveQuery(queryParams:Object, data:Object):void

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

Saves queries to be replayed offline later.

Parameters

queryParams:Object — the parameters of the query
 
data:Object — the data to store in the referenced columns

updateOfflineItem

()method 
public function updateOfflineItem(item:Object, propChangeList:Array):void

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

Updates the specified properties of the specified offline item in the local store. The property change list is not used with default local shared object implementation as it is not needed.

Parameters

item:Object — the item to update, containing new values.
 
propChangeList:Array — a list of properties that are being updated.

updateOfflineItems

()method 
public function updateOfflineItems(itemUpdates:Dictionary):void

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

It is used to update the items that were modified to the local store. It takes in a dictionary where the key passed in is the updated item self and the value would be a array of the properties changes. The property change list is not used with default local shared object implementation as it is not needed.

Parameters

itemUpdates:Dictionary — the map of items to the array of changed properties