| Package | mx.data |
| Class | public class CacheDataDescriptor |
| Inheritance | CacheDataDescriptor  EventDispatcher Object |
| Implements | IExternalizable |
| Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
getCacheDescriptors() method of the
associated service.
Related API Elements
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 | ||
| 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 | ||
| 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 this object, formatted according to locale-specific conventions. | Object | |
[override]
Returns a String representation of the CacheDataDescriptor object. | CacheDataDescriptor | ||
|
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() 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 | ||
created | property |
created:Date [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle 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():Dateid | property |
id:Object [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle 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():ObjectlastAccessed | property |
lastAccessed:Date [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle 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():DatelastWrite | property |
lastWrite:Date [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle 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():Datemetadata | property |
metadata:Object| Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle 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):voidRelated API Elements
synced | property |
public var synced:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle 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: | LiveCycle 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():uintCacheDataDescriptor | () | Constructor |
public function CacheDataDescriptor(dataList:DataList = null)| Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle 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.
ParametersdataList:DataList (default = null) |
toString | () | method |
ALL | Constant |
public static const ALL:uint = 0| Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle 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
FILL | Constant |
public static const FILL:uint = 1| Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle 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
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
}
ITEM | Constant |
public static const ITEM:uint = 2| Language Version: | ActionScript 3.0 |
| Product Version: | LiveCycle 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
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
}
Wed Nov 21 2018, 06:34 AM -08:00