| Paket | mx.data |
| Klass | public class MessageBatch |
| Arv | MessageBatch  EventDispatcher Object |
| Implementerar | IExternalizable |
| Språkversion: | ActionScript 3.0 |
| Produktversion: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
DataStore.currentBatch
property. Changes you make such as property changes detected automatically through
data binding, createItem(), updateItem(), or deleteItem() operations are stored in this
batch. The current list of uncommitted batches is stored in the uncommittedBatches property.
You call createBatch create a new batch which is added to the end of the list. This batch
is automatically made the currentBatch.
You can commit or revert the set of a changes a batch at a time - in both cases, the batch is
automatically removed from the uncommittedBatches list.
When there are dependencies between changes, you should commit and revert changes in order - i.e. commit the oldest batch in the list (uncommittedBatches[0]) and revert the most recent batch - uncommittedBatches[uncommittedBatches.length - 1].
The commitRequired property is set to true when there are any changes in the batch
(i.e. items.length > 0). The items property stores the set of DataMessages in this batch.
You can store custom information in a MessageBatch via the properties
property. Batches are saved/restored each time you use the saveCache method
or automatically when autoSaveCache is true when using the offline feature.
Each batch also has a DataMessage associated with it in the batchMessage property.
If you need to communicate information with the server (and you are sending the batch
message to the server) you can store info in the headers of this message.
Dölj ärvda publika egenskaper
Visa ärvda publika egenskaper| Egenskap | Definieras med | ||
|---|---|---|---|
| batchMessage : DataMessage
This is the data message used to represent the batch being sent to the server. | MessageBatch | ||
| commitRequired : Boolean [skrivskyddad]
True if any changes are in this batch. | MessageBatch | ||
 | constructor : Object
En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans. | Object | |
| properties : Object = null
An optional set of user defined properties you can set for this batch. | MessageBatch | ||
| Metod | Definieras med | ||
|---|---|---|---|
Constructor. | MessageBatch | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registrerar ett händelseavlyssnarobjekt för ett EventDispatcher-objekt så att avlyssnaren får meddelanden om händelser. | EventDispatcher | |
Commits the changes in the batch. | MessageBatch | ||
Indicates if there are pending changes for this particular item. | MessageBatch | ||
|
Skickar en händelse till händelseflödet. | EventDispatcher | |
Returns the message with the given id. | MessageBatch | ||
|
Kontrollerar om EventDispatcher-objektet har några avlyssnare registrerade för en viss typ av händelse. | EventDispatcher | |
|
Anger om det finns en egenskap angiven för ett objekt. | Object | |
|
Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som parameter. | Object | |
|
Anger om den angivna egenskapen finns och är uppräkningsbar. | Object | |
This method deserializes the message batch. | MessageBatch | ||
|
Tar bort en avlyssnare från EventDispatcher-objektet. | EventDispatcher | |
Removes the specified message from this batch. | MessageBatch | ||
Reverts the changes for this batch, either all changes if no item is supplied,
or just the changes for the specified item if it is supplied. | MessageBatch | ||
Reverts the changes for all items in the specified managed collection. | MessageBatch | ||
|
Anger tillgänglighet för en dynamisk egenskap för slingåtgärder. | Object | |
|
Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner. | Object | |
[åsidosätt]
Returns a String representation of this object. | MessageBatch | ||
|
Returnerar det angivna objektets primitiva värde. | Object | |
|
Kontrollerar om en händelseavlyssnare är registrerad för det här EventDispatcher-objektet eller något av dess överordnade objekt för den angivna händelsetypen. | EventDispatcher | |
This method serializes the batch with the following stucture:
numberOfElements:int - this is the total number of elements serialized
[repeated element (once for every message in the batch)]
destination:String - the destination of the associated DataService
uid:String - the UID of the associated item
message:DataMessage - the message for the associated change
Because the message currently contains a copy of the item we don't have
to serialize the message in a special way. | MessageBatch | ||
| Konstant | Definieras med | ||
|---|---|---|---|
| items : ArrayCollection
This stores the list of MessageCacheItem instances which represent the
changes in the batch. | MessageBatch | ||
batchMessage | egenskap |
public var batchMessage:DataMessage| Språkversion: | ActionScript 3.0 |
| Produktversion: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
This is the data message used to represent the batch being sent to the server. If you need to pass additional per-transaction information you might use the headers of this message to communicate with your server code (assuming it actually sends the message instead of converting it on the client).
commitRequired | egenskap |
commitRequired:Boolean [skrivskyddad] | Språkversion: | ActionScript 3.0 |
| Produktversion: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
True if any changes are in this batch. This is a bindable property.
Den här egenskapen kan användas som källan för databindning. När den här egenskapen ändras, skickas händelsen propertyChange .
Implementering
public function get commitRequired():Booleanproperties | egenskap |
public var properties:Object = null| Språkversion: | ActionScript 3.0 |
| Produktversion: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
An optional set of user defined properties you can set for this batch.
MessageBatch | () | Konstruktor |
public function MessageBatch()| Språkversion: | ActionScript 3.0 |
| Produktversion: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Constructor.
commit | () | metod |
public function commit(itemsOrCollections:Array = null, cascadeCommit:Boolean = false):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Commits the changes in the batch. Typically called with no arguments.
Parametrar
itemsOrCollections:Array (default = null)itemsOrCollections parameter.
| |
cascadeCommit:Boolean (default = false)true to ensure that changes to associated items
are also included in the commit.
|
mx.rpc:AsyncToken — AsyncToken reference to the token that will identify this
operation in a result or fault event dispatched from this service.
|
commitRequiredOn | () | metod |
public function commitRequiredOn(item:Object):Boolean| Språkversion: | ActionScript 3.0 |
| Produktversion: | Adobe Digital Enterprise Platform Data Services for Java EE 3.1 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Indicates if there are pending changes for this particular item.
Parametrar
item:Object — The object that might have changes.
|
Boolean — true if the item has pending changes.
|
getMessage | () | metod |
public function getMessage(messageId:String):DataMessage| Språkversion: | ActionScript 3.0 |
| Produktversion: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Returns the message with the given id. Returns null of no message with the given id exists in this batch.
Parametrar
messageId:String — id of desired message.
|
DataMessage — the message with the given id. Returns null of no message
with the given id exists in this batch.
|
readExternal | () | metod |
public function readExternal(input:IDataInput):void| Språkversion: | ActionScript 3.0 |
| Produktversion: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
This method deserializes the message batch. It expects the input byte stream to have the following structure:
- numberOfElements:int - this is the total number of elements serialized [repeated element (once for every message in the batch)] t]
- destination:String - the destination of the associated DataService
- uid:String - the UID of the associated item
- message:DataMessage - the message for the associated change
Parametrar
input:IDataInput — input stream
|
removeMessage | () | metod |
public function removeMessage(msg:DataMessage):void| Språkversion: | ActionScript 3.0 |
| Produktversion: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Removes the specified message from this batch.
Parametrar
msg:DataMessage — message to be removed.
|
revertChanges | () | metod |
public function revertChanges(item:IManaged = null):Boolean| Språkversion: | ActionScript 3.0 |
| Produktversion: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Reverts the changes for this batch, either all changes if no item is supplied, or just the changes for the specified item if it is supplied. You should typically only revert changes in the most recent batch as the system does not resolve or fix dependencies if you revert an older change which was depended upon by a later change.
Parametrar
item:IManaged (default = null) |
Boolean — true if the revert completed successfully.
|
revertChangesForCollection | () | metod |
public function revertChangesForCollection(collection:ListCollectionView):Boolean| Språkversion: | ActionScript 3.0 |
| Produktversion: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Reverts the changes for all items in the specified managed collection.
Parametrar
collection:ListCollectionView — The collection to revert.
|
Boolean — true if the revert completed successfully.
|
toString | () | metod |
override public function toString():String| Språkversion: | ActionScript 3.0 |
| Produktversion: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
Returns a String representation of this object.
ReturnerarString — A String representation of this object.
|
writeExternal | () | metod |
public function writeExternal(output:IDataOutput):void| Språkversion: | ActionScript 3.0 |
| Produktversion: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
This method serializes the batch with the following stucture:
- numberOfElements:int - this is the total number of elements serialized [repeated element (once for every message in the batch)]
- destination:String - the destination of the associated DataService
- uid:String - the UID of the associated item
- message:DataMessage - the message for the associated change
Because the message currently contains a copy of the item we don't have to serialize the message in a special way.
Parametrar
output:IDataOutput — object to write serialized bytes to.
|
items | Konstant |
public const items:ArrayCollection| Språkversion: | ActionScript 3.0 |
| Produktversion: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Körningsmiljöversioner: | Flash Player 9, AIR 1.1 |
This stores the list of MessageCacheItem instances which represent the changes in the batch. It is bindable so you can listen for change events on this collection to be notified of new changes.
Tue Jun 12 2018, 01:40 PM Z