DeltaPacket

Kind of class:interface
Inherits from:Collection
Implemented by:
Classpath:mx.data.components.datasetclasses.DeltaPacket
File last modified:Tuesday, 18 December 2007, 15:44:38
The DeltaPacket interface provides access to the source component (e.g. DataSet)
and the collection of Delta created during modifications to the DataSet and its
transfer objects.

Summary


Instance methods
  • getConfigInfo (info:Object) : Object
    • Returns configuration information that is specific to the implementation of
  • getIterator : Iterator
    • Returns an iterator for this collection.
  • getKeyInfo : Object
    • Returns the key information about this delta packet's items.
  • getSource : Object
    • Returns the source of this DeltaPacket.
  • getTransactionId : String
    • Returns the transaction ID of this DeltaPacket.
  • getTimestamp : Date
    • Returns the date and time when this DeltaPacket was created.
  • logChanges : Boolean
    • Returns if the application of this delta packet should be logged.
Instance methods inherited from Collection
addItem clear contains getItemAt getIterator getLength isEmpty removeItem

Instance methods

getConfigInfo

function getConfigInfo (
info:Object) : Object

Returns configuration information that is specific to the implementation of
the DeltaPacket. This method allows implementations of the DeltaPacket interface
to access custom information using this interface.
Parameters:
info:
Object containing information that only the implementation will
understand
Returns:
  • Object contiaining the requested information

getIterator

function getIterator (
) : Iterator

Returns an iterator for this collection.
Returns:
  • Iterator
Overrides:

getKeyInfo

function getKeyInfo (
) : Object

Returns the key information about this delta packet's items. This information
is used during the resolve process between a component and the delta packet.
Returns:
  • Object containing key property information for the items descibed in
    this delta packet.
    tiptext Returns key information

getSource

function getSource (
) : Object

Returns the source of this DeltaPacket.
Returns:
  • Object source of this DeltaPacket i.e. which DataSet did it come from.

getTimestamp

function getTimestamp (
) : Date

Returns the date and time when this DeltaPacket was created.
Returns:
  • Date containing the date and time this delta packet was created.

getTransactionId

function getTransactionId (
) : String

Returns the transaction ID of this DeltaPacket.
Returns:
  • String transaction id for this delta packet

logChanges

function logChanges (
) : Boolean

Returns if the application of this delta packet should be logged.
Returns:
  • Boolean indicating if the changes of this packet should
    be logged when applied.