DeltaImpl
| Kind of class: | class |
|---|---|
| Inherits from: | Object |
| Implements: | |
| Classpath: | mx.data.components.datasetclasses.DeltaImpl |
| File last modified: | Tuesday, 18 December 2007, 15:44:38 |
Delta implementation which handles a list of DeltaItems.
Summary
Constructor
- DeltaImpl (id:Object, curSrc:Object, op:Number, msg:String, acl:Boolean)
- Initializes an instance of a Delta.
Instance properties
Instance methods
- addDeltaItem (item:DeltaItem) : Void
- Adds the specified item to the delta item list or replaces an existing one found
- getId : Object
- Returns the unique id for this delta.
- getOperation : Number
- Returns the associated operation for this Delta.
- getChangeList : Array
- Returns the list of changes for the associated transfer object.
- getItemByName (name:String) : DeltaItem
- Returns the DeltaItem with the specified name if it can be found in the list,
- getSource : Object
- Returns the source object that this DeltaImpl has recorded changes for.
- getMessage : String
- Returns any message associated with this Delta.
- getDeltaPacket : Object
- Returns a reference to the DeltaPacket for this Delta.
- getItemIndexByName (name:String) : Number
- Returns the index of a delta item in the list with the specified name, or -1 if
Constructor
DeltaImpl
function DeltaImpl (
id:Object,
curSrc:Object,
op:Number,
msg:String,
acl:Boolean)
Initializes an instance of a Delta.
Parameters:
id :
Object that identifies this Delta within the DeltaPacket
curSrc:
Object source transfer object reference in its current state
msg :
String [optional] message to associate with this delta item
acl :
Boolean [optional] indicates that access to the change list is permitted
at all times.
at all times.
Instance properties
_accessCl
private _accessCl:Boolean
(read)
_deltaItems
private _deltaItems:Array
(read)
_id
private _id:Object
(read)
_message
private _message:String
(read)
_op
private _op:Number
(read)
_owner
private _owner:Object
(read)
_source
private _source:Object
(read)
Instance methods
addDeltaItem
Adds the specified item to the delta item list or replaces an existing one found
with the same name.
with the same name.
Parameters:
item:
DeltaItem to add to the list
getChangeList
function getChangeList (
) : Array
Returns the list of changes for the associated transfer object.
Returns:
- Array of DeltaItems associated with this Delta
Specified by:
getDeltaPacket
function getDeltaPacket (
) : Object
Returns a reference to the DeltaPacket for this Delta.
Returns:
- Object reference to the DeltaPacket for this Delta
Specified by:
getId
function getId (
) : Object
Returns the unique id for this delta.
Returns:
- Object containing the id which relates this delta back to the
associated transfer object.
Specified by:
getItemByName
Returns the DeltaItem with the specified name if it can be found in the list,
if the item can not be found null is returned
if the item can not be found null is returned
Returns:
- DeltaItem with the specified name or null if not found
Specified by:
getItemIndexByName
private function getItemIndexByName (
name:String) : Number
Returns the index of a delta item in the list with the specified name, or -1 if
it isn't found.
it isn't found.
Returns:
- Number index of delta item within the list or -1 if not found.
getMessage
function getMessage (
) : String
Returns any message associated with this Delta.
Returns:
- String containing the associated message or "" if not defined
Specified by:
getOperation
function getOperation (
) : Number
Returns the associated operation for this Delta. Valid values areDeltaPacketConst.Added DeltaPacketConst.Removed DeltaPacketConst.Modified
Returns:
- Number indicating which operation occurred for this Delta.
Specified by:
getSource
function getSource (
) : Object
Returns the source object that this DeltaImpl has recorded changes for.
Returns:
- Object source of the changes
Specified by: