Delta

Kind of class:interface
Inherits from:none
Implemented by:
Classpath:mx.data.components.datasetclasses.Delta
File last modified:Tuesday, 18 December 2007, 15:44:38
The Delta interface provides access to the transfer object, collection,
and transfer object level changes. With this interface either a list of
just the changes to a transfer object or both changed and unchanged
values can be returned.

Summary


Instance methods
  • addDeltaItem (d: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,
  • getMessage : String
    • Returns the message associated with this Delta.
  • getSource : Object
    • Returns the source object that this DeltaImpl has recorded changes for.
  • getDeltaPacket : Object
    • Returns the associated DeltaPacket.

Instance methods

addDeltaItem

function addDeltaItem (
d:DeltaItem) : Void

Adds the specified item to the delta item list or replaces an existing one found
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

getDeltaPacket

function getDeltaPacket (
) : Object

Returns the associated DeltaPacket.
Returns:
  • Object DeltaPacket this Delta belongs to

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.

getItemByName

function getItemByName (
name:String) : DeltaItem

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
Returns:
  • DeltaItem with the specified name or null if not found

getMessage

function getMessage (
) : String

Returns the message associated with this Delta.
Returns:
  • String containing the associated message or blank if not defined

getOperation

function getOperation (
) : Number

Returns the associated operation for this Delta. Valid values are
  • DeltaPacketConst.Added
  • DeltaPacketConst.Removed
  • DeltaPacketConst.Modified
    • Returns:
    • Number indicating which operation occurred for this Delta.

    getSource

    function getSource (
    ) : Object

    Returns the source object that this DeltaImpl has recorded changes for.
    Returns:
    • Object source of the changes