| Pacchetto | mx.data |
| Classe | public class MessageBatch |
| Ereditarietà | MessageBatch  EventDispatcher Object |
| Implementa | IExternalizable |
| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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.
Nascondi proprietà pubbliche ereditate
Mostra proprietà pubbliche ereditate| Proprietà | Definito da | ||
|---|---|---|---|
| batchMessage : DataMessage
This is the data message used to represent the batch being sent to the server. | MessageBatch | ||
| commitRequired : Boolean [sola lettura]
True if any changes are in this batch. | MessageBatch | ||
 | constructor : Object
Un riferimento all'oggetto classe o alla funzione di costruzione per una determinata istanza di oggetto. | Object | |
| properties : Object = null
An optional set of user defined properties you can set for this batch. | MessageBatch | ||
| Metodo | Definito da | ||
|---|---|---|---|
Constructor. | MessageBatch | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra un oggetto listener di eventi con un oggetto EventDispatcher, in modo che il listener riceva la notifica di un evento. | EventDispatcher | |
Commits the changes in the batch. | MessageBatch | ||
Indicates if there are pending changes for this particular item. | MessageBatch | ||
|
Invia un evento nel flusso di eventi. | EventDispatcher | |
Returns the message with the given id. | MessageBatch | ||
|
Verifica se per l'oggetto EventDispatcher sono presenti listener registrati per un tipo specifico di evento. | EventDispatcher | |
|
Indica se per un oggetto è definita una proprietà specifica. | Object | |
|
Indica se un'istanza della classe Object si trova nella catena di prototipi dell'oggetto specificato come parametro. | Object | |
|
Indica se la proprietà specificata esiste ed è enumerabile. | Object | |
This method deserializes the message batch. | MessageBatch | ||
|
Rimuove un listener dall'oggetto EventDispatcher. | 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 | ||
|
Imposta la disponibilità di una proprietà dinamica per le operazioni cicliche. | Object | |
|
Restituisce la rappresentazione in formato stringa di questo oggetto, formattato in base alle convenzioni specifiche per le versioni localizzate. | Object | |
[override]
Returns a String representation of this object. | MessageBatch | ||
|
Restituisce il valore di base dell'oggetto specificato. | Object | |
|
Verifica se un listener di eventi è registrato con questo oggetto EventDispatcher o qualsiasi suo antenato per il tipo di evento specificato. | 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 | ||
| Costante | Definito da | ||
|---|---|---|---|
| items : ArrayCollection
This stores the list of MessageCacheItem instances which represent the
changes in the batch. | MessageBatch | ||
batchMessage | proprietà |
public var batchMessage:DataMessage| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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 | proprietà |
commitRequired:Boolean [sola lettura] | Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
True if any changes are in this batch. This is a bindable property.
Questa proprietà può essere utilizzata come origine per l’associazione di dati. Quando questa proprietà viene modificata, invia l’evento propertyChange .
Implementazione
public function get commitRequired():Booleanproperties | proprietà |
public var properties:Object = null| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
An optional set of user defined properties you can set for this batch.
MessageBatch | () | Funzione di costruzione |
public function MessageBatch()| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Constructor.
commit | () | metodo |
public function commit(itemsOrCollections:Array = null, cascadeCommit:Boolean = false):mx.rpc:AsyncToken| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Commits the changes in the batch. Typically called with no arguments.
Parametri
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 | () | metodo |
public function commitRequiredOn(item:Object):Boolean| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Data Services per Java EE 3.1 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Indicates if there are pending changes for this particular item.
Parametri
item:Object — The object that might have changes.
|
Boolean — true if the item has pending changes.
|
getMessage | () | metodo |
public function getMessage(messageId:String):DataMessage| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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.
Parametri
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 | () | metodo |
public function readExternal(input:IDataInput):void| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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
Parametri
input:IDataInput — input stream
|
removeMessage | () | metodo |
public function removeMessage(msg:DataMessage):void| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Removes the specified message from this batch.
Parametri
msg:DataMessage — message to be removed.
|
revertChanges | () | metodo |
public function revertChanges(item:IManaged = null):Boolean| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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.
Parametri
item:IManaged (default = null) |
Boolean — true if the revert completed successfully.
|
revertChangesForCollection | () | metodo |
public function revertChangesForCollection(collection:ListCollectionView):Boolean| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Reverts the changes for all items in the specified managed collection.
Parametri
collection:ListCollectionView — The collection to revert.
|
Boolean — true if the revert completed successfully.
|
toString | () | metodo |
override public function toString():String| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Returns a String representation of this object.
RestituisceString — A String representation of this object.
|
writeExternal | () | metodo |
public function writeExternal(output:IDataOutput):void| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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.
Parametri
output:IDataOutput — object to write serialized bytes to.
|
items | Costante |
public const items:ArrayCollection| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Data Services per Java EE 3 |
| Versioni runtime: | 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, 02:44 PM Z