CacheDataDescriptor

Package	mx.data
Class	public class CacheDataDescriptor
Inheritance	CacheDataDescriptor EventDispatcher Object
Implements	IExternalizable

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 CacheDataDescriptor class provides information about the attributes of cached data. It can be used to by developers to gain access to usage statistics. When data is successfully stored in the local cache a CacheDataDescriptor is created to represent that data. Descriptors can be accessed using the getCacheDescriptors() method of the associated service.

Related API Elements

mx.data.DataService.getCacheDescriptors

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		created : Date [read-only] The time in UTC that this cached data was first created in the local store.	CacheDataDescriptor
		id : Object [read-only] The unique ID of the data cached.	CacheDataDescriptor
		lastAccessed : Date [read-only] The time in UTC that this cached data was last accessed from the local store.	CacheDataDescriptor
		lastFilled : Date The time in UTC that this cached data was last filled from a remote server.	CacheDataDescriptor
		lastWrite : Date [read-only] The time in UTC that this cached data was last written to the local store.	CacheDataDescriptor
		metadata : Object Provides access to custom information stored along with this data in the local store.	CacheDataDescriptor
		synced : Boolean = false Contains true if this query was synced when it was requested from the server.	CacheDataDescriptor
		type : uint [read-only] The type of data this cache descriptor is associated with.	CacheDataDescriptor

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		CacheDataDescriptor(dataList:DataList = null) Initializes this descriptor with the specified cache item and associated id.	CacheDataDescriptor
		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
		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
		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
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Returns a String representation of the CacheDataDescriptor object.	CacheDataDescriptor
		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

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Public Constants

	Constant		Defined By
		ALL : uint = 0 [static] Option for use with the getCacheDescriptors() method to indicate the type of descriptors to return.	CacheDataDescriptor
		FILL : uint = 1 [static] Option for use with the getCacheDescriptors() method to indicate the type of descriptors to return.	CacheDataDescriptor
		ITEM : uint = 2 [static] Option for use with the getCacheDescriptors() method to indicate the type of descriptors to return.	CacheDataDescriptor

Property Detail

created

property

created:Date [read-only]

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 time in UTC that this cached data was first created in the local store. This value is set when autoSave is true is called and a fill(), getItem(), or createItem() request for data that is not already in the local store is completed; or saveCache() is called. Invocations of these methods when the data is already cached will change the last accessed time. The last updated time will also be updated if the cached data is updated as a result of the request.

Implementation
public function get created():Date

id

property

id:Object [read-only]

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 unique ID of the data cached. This is the value that the service uses to uniquely identify this data. For collections of items this is the value defined by the remote destination when a fill request is made. For single managed objects (SMOs) this is a map of name value pairs for the item as defined by the <identity> tag in the services-config.xml file.

Implementation
public function get id():Object

lastAccessed

property

lastAccessed:Date [read-only]

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 time in UTC that this cached data was last accessed from the local store. This value is set when a fill(), getItem(), or createItem() request for data that is not already in the local store is completed.

Implementation
public function get lastAccessed():Date

lastFilled

property

lastFilled:Date

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Data Services for Java EE 4.5

Runtime Versions:

Flash Player 10.1, AIR 2.0

The time in UTC that this cached data was last filled from a remote server. Used to restore the fillTimestamp field of a dataList, which allows subsequent synchronizeFill() calls to know which changed data to retrieve from the server.

Implementation
public function get lastFilled():Date
public function set lastFilled(value:Date):void

lastWrite

property

lastWrite:Date [read-only]

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 time in UTC that this cached data was last written to the local store. This value is set when autoSave is true is called and a fill(), getItem(), or createItem() request for data that is not already in the local store is completed; or saveCache() is called. The last write time will be updated if the cached data is updated as a result of the request or a pushed update occurs when autoSave is true.

Implementation
public function get lastWrite():Date

metadata

property

metadata:Object

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

Provides access to custom information stored along with this data in the local store. Values assigned to this property must be serializable, that is, implement flash.util.IExternalizable or descend from no UI based objects. Typically this value is a string description of the data's relevance within the system. For example "All gold customers" or "All orders over $10K".

Implementation
public function get metadata():Object
public function set metadata(value:Object):void

Related API Elements

flash.util.IExternalizable

synced

property

public var synced:Boolean = false

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

Contains true if this query was synced when it was requested from the server. A synced query is one for which the server pushes change notifications to the client. Therefore, a true value indicates an up to date, with respect to the server, query at the time of its persistence to the local store.

type

property

type:uint [read-only]

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 type of data this cache descriptor is associated with. Valid values are:

CacheDataDescriptor.FILL - descriptor is for a filled collection.
CacheDataDescriptor.ITEM - descriptor is for a managed item.

Implementation
public function get type():uint

Constructor Detail

()

Constructor

public function CacheDataDescriptor(dataList:DataList = 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

Initializes this descriptor with the specified cache item and associated id.

Parameters

dataList:DataList (default = null) — DataList reference to the associated items.

Method Detail

toString

()

method

override public function toString():String

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

Returns a String representation of the CacheDataDescriptor object.

Returns

String — A String representation of the CacheDataDescriptor object.

Constant Detail

ALL

Constant

public static const ALL:uint = 0

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

Option for use with the getCacheDescriptors() method to indicate the type of descriptors to return. This constant indicates that descriptors for both filled collections and single managed objects should be returned.

Related API Elements

mx.data.DataService.getCacheDescriptors

FILL

Constant

public static const FILL:uint = 1

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

Option for use with the getCacheDescriptors() method to indicate the type of descriptors to return. This constant indicates that only descriptors for filled collections should be returned. This constant is also used to indicate the value of a descriptor's type.

Related API Elements

mx.data.DataService.getCacheDescriptors

Example ( How to use this example )

Copy

 
         var desc:CacheDataDescriptor = CacheDataDescriptor(descriptors.getItemAt(0));
         if (desc.type == CacheDataDescriptor.FILL)
         {
            // this descriptor contains attribute data for a filled collection
         }
         else if (desc.type == CacheDataDescriptor.ITEM)
         {
            // this descriptor contains attribute data for a single managed item
         }

ITEM

Constant

public static const ITEM:uint = 2

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

Option for use with the getCacheDescriptors() method to indicate the type of descriptors to return. This constant indicates that only descriptors for single managed objects collections should be returned. This constant is also used to indicate the value of a descriptor's type.

Related API Elements

mx.data.DataService.getCacheDescriptors

Example ( How to use this example )

Copy

 
         var desc:CacheDataDescriptor = CacheDataDescriptor(descriptors.getItemAt(0));
         if (desc.type == CacheDataDescriptor.FILL)
         {
            // this descriptor contains attribute data for a filled collection
         }
         else if (desc.type == CacheDataDescriptor.ITEM)
         {
            // this descriptor contains attribute data for a single managed item
         }

CacheDataDescriptor - AS3 ADEP Data Services

Classes x

created

id

lastAccessed

lastFilled

lastWrite

metadata

synced

type