| Package | mx.data |
| Class | public class CacheDataDescriptor |
| Inheritance | CacheDataDescriptor EventDispatcher Object |
| Implements | IExternalizable |
See also
| Property | Defined By | ||
|---|---|---|---|
![]() | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| created : Date
[read-only]
Returns the time in UTC that this cached data was
first created in the local store.
| CacheDataDescriptor | ||
| id : Object
[read-only]
Returns the unique ID of the data cached.
| CacheDataDescriptor | ||
| lastAccessed : Date
[read-only]
Returns the time in UTC that this cached data was
last accessed from the local store.
| CacheDataDescriptor | ||
| lastWrite : Date
[read-only]
Returns 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 | ||
![]() | prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| type : uint
[read-only]
Returns 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.
| CacheDataDescriptor | ||
| 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 | |
![]() |
Dispatches an event into the event flow.
| EventDispatcher | |
![]() |
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event.
| EventDispatcher | |
![]() |
Indicates whether an object has a specified property defined.
| Object | |
![]() |
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
![]() |
Indicates whether the specified property exists and is enumerable.
| Object | |
![]() |
Removes a listener from the EventDispatcher object.
| EventDispatcher | |
![]() |
Sets the availability of a dynamic property for loop operations.
| Object | |
![]() |
Returns the string representation of the specified object.
| Object | |
![]() |
Returns the primitive value of the specified object.
| Object | |
![]() |
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type.
| EventDispatcher | |
| Constant | Defined By | ||
|---|---|---|---|
| ALL : uint = 0 [static]
Option for use with the getCacheDescriptors(), indicates
what type of descriptors should be returned.
| CacheDataDescriptor | ||
| FILL : uint = 1 [static]
Option for use with the getCacheDescriptors(), indicates
what type of descriptors should be returned.
| CacheDataDescriptor | ||
| ITEM : uint = 2 [static]
Option for use with the getCacheDescriptors(), indicates
what type of descriptors should be returned.
| CacheDataDescriptor | ||
| created | property |
created:Date [read-only] Returns 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.
public function get created():Date
| destination | property |
mx_internal var destination:String
This value is used to lookup the current DataService and is assigned after this descriptor has been loaded from the local store, it is not stored with the descriptor.
| id | property |
id:Object [read-only] Returns 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 desfined 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.
public function get id():Object
| lastAccessed | property |
lastAccessed:Date [read-only] Returns 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.
public function get lastAccessed():Date
| lastWrite | property |
lastWrite:Date [read-only] Returns 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.
public function get lastWrite():Date
| metadata | property |
metadata:Object [read-write] Provides access to custom information stored along with this data in the local store. Values assinged 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"
public function get metadata():Object
public function set metadata(value:Object):void
| references | property |
references:Array [read-write] mx_internal function get references():Array
mx_internal function set references(value:Array):void
| type | property |
type:uint [read-only] Returns the type of data this cache descriptor is associated with Valid values are:
public function get type():uint
| CacheDataDescriptor | () | Constructor |
public function CacheDataDescriptor(dataList:DataList = null)
Initializes this descriptor with the specified cache item and associated id.
ParametersdataList:DataList (default = null) — DataList reference to the associated items.
|
| ALL | Constant |
public static const ALL:uint = 0
Option for use with the getCacheDescriptors(), indicates
what type of descriptors should be returned.
This constant indicates that descriptors for both filled collections and
single managed objects should be returned.
See also
| FILL | Constant |
public static const FILL:uint = 1
Option for use with the getCacheDescriptors(), indicates
what type of descriptors should be returned.
This option indicates that only descriptors for filled collections
should be returned.
This constant is also used to indicate the value of a descriptor's
type.
See also
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
Option for use with the getCacheDescriptors(), indicates
what type of descriptors should be returned.
This option 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.
See also
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
}
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/mx/data/CacheDataDescriptor.html