Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 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.
created:Date
[read-only]
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 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:Object
[read-only]
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 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:Date
[read-only]
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 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
lastWrite:Date
[read-only]
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 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:Object
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 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
See also
flash.util.IExternalizable
public var synced:Boolean = false
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 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:uint
[read-only]
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 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
public function CacheDataDescriptor(dataList:DataList = null)
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 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.
|
override public function toString():String
Returns a String representation of the CacheDataDescriptor object.
Returns | String — A String representation of the CacheDataDescriptor object.
|
public static const ALL:uint = 0
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 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.
See also
public static const FILL:uint = 1
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 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
.
See also
Example (
How to use this example )
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
}
public static const ITEM:uint = 2
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 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
.
See also
Example (
How to use this example )
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
}