| Package | mx.data |
| Classe | public class MessageBatch |
| Héritage | MessageBatch  EventDispatcher Object |
| Implémente | IExternalizable |
| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
DataStore.currentBatch. Les modifications que vous réalisez, par exemple les modifications de propriété détectées automatiquement, par le biais d’une liaison de données ou d’opérations createItem, updateItem ou deleteItem, sont stockées dans ce lot. La liste actuelle des lots non validés est stockée dans la propriété uncommittedBatches. L’appel de createBatch crée un nouveau lot, ajouté à la fin de la liste. Ce lot est automatiquement désigné comme lot currentBatch. Vous pouvez valider ou rétablir simultanément l’ensemble des modifications d’un lot. Dans tous les cas, le lot est supprimé automatiquement de la liste uncommittedBatches.
Lorsque des dépendances existent entre les modifications, vous devez valider et rétablir les modifications dans l’ordre. Ainsi, vous devez valider le lot le plus ancien de la liste (uncommittedBatches[0]) et rétablir le lot le plus récent : uncommittedBatches[uncommittedBatches.length - 1].
La propriété commitRequired est définie sur true lorsque le lot contient des modifications, c’est-à-dire lorsque items.length > 0. La propriété items stocke l’ensemble des instances DataMessage de ce lot.
Vous pouvez stocker des informations personnalisées dans une instance MessageBatch par le biais de la propriété properties. Les lots sont enregistrés/restaurés chaque fois que vous utilisez la méthode saveCache, mais aussi automatiquement lorsque la valeur de la propriété autoSaveCache est true et que vous utilisez la fonctionnalité hors ligne.
A chaque lot correspond une instance DataMessage associée dans la propriété batchMessage. Si vous devez communiquer des informations au serveur (et que vous envoyez le message de lot au serveur), vous pouvez stocker des informations dans les en-têtes de ce message.
Masquer les propriétés publiques héritées
Afficher les propriétés publiques héritées| Propriété | Défini par | ||
|---|---|---|---|
| batchMessage : DataMessage
Il s’agit du message de données utilisé pour représenter le lot envoyé au serveur. | MessageBatch | ||
| commitRequired : Boolean [lecture seule]
True si ce lot contient des modifications. | MessageBatch | ||
 | constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | |
| properties : Object = null
Ensemble facultatif de propriétés définies par l’utilisateur, que vous pouvez définir pour ce lot. | MessageBatch | ||
| Méthode | Défini par | ||
|---|---|---|---|
Constructeur. | MessageBatch | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. | EventDispatcher | |
Valide les modifications du lot. | MessageBatch | ||
Indique s’il existe des modifications en attente pour cet élément particulier. | MessageBatch | ||
|
Distribue un événement dans le flux d’événements. | EventDispatcher | |
Renvoie le message avec l’id donné. | MessageBatch | ||
|
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | EventDispatcher | |
|
Indique si la propriété spécifiée d’un objet est définie. | Object | |
|
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | |
|
Indique si la propriété spécifiée existe et est énumérable. | Object | |
Cette méthode désérialise le lot de messages. | MessageBatch | ||
|
Supprime un écouteur de l’objet EventDispatcher. | EventDispatcher | |
Supprime le message spécifié de ce lot. | MessageBatch | ||
Rétablit les modifications de ce lot. Si aucun élément n’est spécifié, toutes les modifications sont rétablies. Si un élément est spécifié, seules ses modifications sont rétablies. | MessageBatch | ||
Rétablit les modifications de tous les éléments de la collection gérée spécifiée. | MessageBatch | ||
|
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | |
|
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | |
[override]
Renvoie une représentation de chaîne de cet objet | MessageBatch | ||
|
Renvoie la valeur primitive de l’objet spécifié. | Object | |
|
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié. | EventDispatcher | |
Cette méthode sérialise le lot selon la structure suivante : numberOfElements:int : nombre total d’éléments sérialisés [élément répété (une fois pour chaque message du lot)]. destination:String : destination de l’instance DataService associée. uid:String : UID de l’élément associé. message:DataMessage : message de la modification associée. Le message contenant actuellement une copie de l’élément, il n’est pas nécessaire de sérialiser le message de façon particulière. | MessageBatch | ||
| Constante | Défini par | ||
|---|---|---|---|
| items : ArrayCollection
Cette constante stocke la liste des instances MessageCacheItem représentant les modifications du lot. | MessageBatch | ||
batchMessage | propriété |
public var batchMessage:DataMessage| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Il s’agit du message de données utilisé pour représenter le lot envoyé au serveur. Si vous souhaitez transmettre d’autres informations propres à une transaction, vous pouvez utiliser les en-têtes de ce message pour communiquer avec le code du serveur (à condition qu’il envoie réellement le message au lieu de le convertir sur le client).
commitRequired | propriété |
commitRequired:Boolean [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
True si ce lot contient des modifications. Cette propriété peut être liée.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .
Implémentation
public function get commitRequired():Booleanproperties | propriété |
public var properties:Object = null| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Ensemble facultatif de propriétés définies par l’utilisateur, que vous pouvez définir pour ce lot.
MessageBatch | () | Constructeur |
public function MessageBatch()| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Constructeur.
commit | () | méthode |
public function commit(itemsOrCollections:Array = null, cascadeCommit:Boolean = false):mx.rpc:AsyncToken| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Valide les modifications du lot. Appelé en général sans arguments.
Paramètres
itemsOrCollections:Array (default = null)itemsOrCollections.
| |
cascadeCommit:Boolean (default = false)true, pour garantir que les modifications apportées aux éléments associés sont également incluses dans la validation.
|
mx.rpc:AsyncToken — Référence ASyncToken au jeton qui identifie cette opération dans un événement de résultat ou d’erreur distribué par ce service.
|
commitRequiredOn | () | méthode |
public function commitRequiredOn(item:Object):Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Data Services for Java EE 3.1 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Indique s’il existe des modifications en attente pour cet élément particulier.
Paramètres
item:Object — L’objet susceptible d’avoir des modifications.
|
Boolean — true si l’élément a des modifications en attente.
|
getMessage | () | méthode |
public function getMessage(messageId:String):DataMessage| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Renvoie le message avec l’id donné. Renvoie la valeur null (aucun message avec l’id donné n’existe dans ce lot).
Paramètres
messageId:String — ID du message désiré.
|
DataMessage — message avec l’id donné. Renvoie la valeur null (aucun message avec l’id donné n’existe dans ce lot).
|
readExternal | () | méthode |
public function readExternal(input:IDataInput):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Cette méthode désérialise le lot de messages. Le flux d’octets d’entrée doit avoir la structure suivante :
- numberOfElements:int : il s’agit du nombre total d’éléments sérialisés [élément répété (une fois pour chaque message dans le lot)]
- destination:String : la destination de l’instance DataService associée
- uid:String : l’UID de l’élément associé
- message:DataMessage : le message de la modification associée
Paramètres
input:IDataInput — flux d’entrée
|
removeMessage | () | méthode |
public function removeMessage(msg:DataMessage):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Supprime le message spécifié de ce lot.
Paramètres
msg:DataMessage — message à supprimer.
|
revertChanges | () | méthode |
public function revertChanges(item:IManaged = null):Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Rétablit les modifications de ce lot. Si aucun élément n’est spécifié, toutes les modifications sont rétablies. Si un élément est spécifié, seules ses modifications sont rétablies. En règle générale, vous devez rétablir uniquement les modifications du lot le plus récent, car le système ne résout pas les dépendances et ne les corrige pas non plus si vous rétablissez une modification ancienne qui dépendait d’une modification ultérieure.
Paramètres
item:IManaged (default = null) |
Boolean — true si le rétablissement s’est bien terminé.
|
revertChangesForCollection | () | méthode |
public function revertChangesForCollection(collection:ListCollectionView):Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Rétablit les modifications de tous les éléments de la collection gérée spécifiée.
Paramètres
collection:ListCollectionView — La collection à rétablir.
|
Boolean — true si le rétablissement s’est bien terminé.
|
toString | () | méthode |
override public function toString():String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Renvoie une représentation de chaîne de cet objet
Valeur renvoyéeString — Représentation de chaîne de cet objet
|
writeExternal | () | méthode |
public function writeExternal(output:IDataOutput):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Cette méthode sérialise le lot en utilisant la structure suivante :
- numberOfElements:int : il s’agit du nombre total d’éléments sérialisés [élément répété (une fois pour chaque message dans le lot)]
- destination:String : la destination de l’instance DataService associée
- uid:String : l’UID de l’élément associé
- message:DataMessage : le message de la modification associée
Comme le message contient actuellement une copie de l’élément, il n’est pas nécessaire de sérialiser le message d’une manière particulière.
Paramètres
output:IDataOutput — Objet dans lequel écrire les octets sérialisés.
|
items | Constante |
public const items:ArrayCollection| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Cette constante stocke la liste des instances MessageCacheItem représentant les modifications du lot. Puisqu’elle peut être liée, vous pouvez écouter les événements change de cette collection pour être informé des nouvelles modifications.
Tue Jun 12 2018, 09:30 AM Z