DataStore  - AS3 ADEP Data Services

Si cette propriété est définie sur true, les opérations modifiant l’état géré par l’instance DataService sont validées immédiatement. Si la valeur est false, vous devez appeler explicitement la méthode commit() pour envoyer les modifications au serveur.

La valeur par défaut est true.

Lorsque cette propriété est définie sur true, les modifications apportées à une collection sont validées immédiatement si la propriété autoCommit est définie sur true. Lorsque la valeur est false, les opérations d’ajout ou de suppression réalisées sur une collection ne sont pas validées immédiatement.

La valeur par défaut est true.

Lorsque la valeur est true et que la propriété autoCommit est également définie sur true, toute modification de valeur de propriété provoque une validation pour cette modification. Si cette valeur est false, le fait de modifier la propriété sur un objet de valeur n’entraîne pas automatiquement l’appel de la méthode commit. Pour valider une mise à jour, vous devez cependant utiliser la méthode commit() explicitement ou appeler la méthode DataManager.updateItem() pour valider uniquement les modifications concernant cet élément.

La valeur par défaut est true.

Indique si ce service doit essayer d’établir une connexion pour les opérations qui nécessitent une connexion. Les opérations telles que fill(), getItem() et count() essaient d’établir une connexion si le service est déconnecté et que la valeur de autoConnect est définie sur true. Utilisez cette propriété pour contrôler le comportement des applications qui se connectent de façon occasionnelle.

Intervalle d’attente, en millisecondes, entre les tentatives de connexion au serveur lorsque la valeur de la propriété autoConnect est true.

La valeur par défaut est 5000.

Contrôle comment les modifications apportées par d’autres clients sont fusionnées dans l’affichage actuel des données du client. Si cette propriété est définie sur false, les messages sont placés en file d’attente jusqu’à ce que l’application appelle explicitement la méthode merge(). Si cette propriété est définie sur true, les modifications sont appliquées au fur et à mesure qu’elles sont effectuées. Si le client possède, pour un élément, des modifications en attente non validées qui entrent en conflit avec les modifications fusionnées, un conflit est généré et ajouté à la liste des conflits non résolus pour ce client. Vous pouvez écouter les événements change liés à cette propriété, afin d’être informé lorsqu’une fusion est nécessaire.

Le cache local contenant les données et les modifications peut être stocké sur le disque. Lorsque la valeur de autoSaveCache est true, chaque fois qu’une modification est réalisée ou qu’une demande distante est renvoyée, ces données sont enregistrées sur le disque. Si un problème survient lors de l’enregistrement des données, soit parce que le disque est saturé, soit parce que les autorisations en écriture sont refusées, un événement FaultEvent est distribué ou une erreur Fault est renvoyée. Si cette valeur est définie sur false (valeur par défaut), les données et les modifications ne sont pas enregistrées sur le disque. Pour forcer l’enregistrement local des données et modifications actuelles, utilisez la méthode saveCache.

Eléments de l’API associés

Permet d’accéder à l’identificateur de cache de ce service. Un identificateur de cache doit être défini avant de réaliser des opérations qui font appel à des données stockées localement sur disque. Si aucun identificateur de cache n’est défini, toutes les méthodes et propriétés du cache sont considérées comme étant incohérentes et une erreur DataServiceError est renvoyée lorsqu’une opération faisant appel à des données du disque local est réalisée. Cette propriété fournit un identificateur « session » unique pour les données stockées localement. Le développeur doit affecter à cette propriété une valeur unique dans l’ensemble de l’application. La propriété est considérée comme non définie si sa valeur null ou une chaîne vide.

Permet d’accéder à l’instance ChannelSet utilisée par cette instance DataStore. L’instance ChannelSet peut être créée et affectée manuellement, ou créée de façon dynamique, de manière à utiliser les canaux configurés pour les destinations utilisant cette instance DataStore. L’instance channelSet doit être la même pour tous les objets DataService utilisant la même instance DataStore.

Contrôle à quel moment un lot de modifications validé est envoyé au serveur lorsque vous appelez la méthode commit sur un deuxième lot alors que le client attend toujours une réponse concernant un lot précédemment validé. Si le lot est envoyé immédiatement au serveur, cela peut poser problème si certaines modifications de ce lot dépendent des modifications réalisées par le serveur au cours de la validation du lot précédent. C’est par exemple le cas lors de la mise à jour d’un élément créé par le serveur dans le cadre du premier lot. Si le client n’a pas encore reçu l’ID affecté par le serveur, la mise à jour n’inclut pas l’ID correct de l’élément. Si le deuxième lot attend systématiquement que le premier lot soit terminé, cela risque d’allonger le temps nécessaire pour réaliser une série de modifications dépendantes de l’heure (par exemple si vous mettez à jour une position de curseur en permanence).

Le mode par défaut est CQ_AUTO. Ce mode impose une vérification des dépendances simples entre les lots en attente et le prochain lot à valider. S’il n’y a pas de lot en attente, le nouveau lot est envoyé immédiatement. Si une opération de mise à jour ou de suppression dépend d’une opération de création en attente, l’opération de mise à jour ou de suppression attend que l’opération de création soit terminée. La vérification des dépendances impose ainsi un certain délai à chaque validation, mais il s’agit en général d’un compromis optimal entre les deux autres modes, CQ_NOWAIT et CQ_ONE_AT_A_TIME.

Le mode CQ_NOWAIT provoque l’envoi immédiat du deuxième lot, sans vérification préalable des dépendances. Vous pouvez utiliser ce mode si vous affectez des ID aux nouveaux objets du client et que vous souhaitez superposer des lots pour obtenir de meilleures performances.

En mode CQ_ONE_AT_A_TIME, la validation d’un nouveau lot ne commence pas tant que le lot précédent n’est pas terminé. Ce mode simplifie la logique de traitement des erreurs en empêchant le serveur de recevoir un lot contenant des modifications manquantes réalisées par le serveur lors du traitement du lot précédent. En outre, en cas d’erreur lors du traitement d’un lot, il permet de faire en sorte que le serveur ne reçoive pas de deuxième lot tant que les erreurs du premier lot n’ont pas été résolues sur le client.

La valeur par défaut est CQ_AUTO.

Indique s’il existe des mises à jour en attente à valider.

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 .

Liste de conflits concernant tous les éléments gérés.

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 .

Indique si l’instance DataStore est connecté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 .

Lot de modifications actuel, qui attend d’être validé sur le serveur si autoCommit=false. Vous pouvez utiliser cette propriété pour réaliser une itération sur les modifications à appliquer lors de l’appel de la méthode commit(). Un lot peut être validé ou rétabli indépendamment des autres lots. L’intégralité de l’ensemble des lots non validés est stockée dans la propriété uncommittedBatches. La valeur de la propriété currentBatch est toujours le dernier lot de la liste uncommittedBatches.

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 .

Destination de cette instance DataStore.

Indicateur pouvant être défini pour désactiver la détection des conflits au cours de l’opération d’actualisation/de reconnexion. Dans la version 2.6.1 de LiveCycle Data Services, aucune détection des conflits n’était réalisée lors de l’actualisation. Vous pouvez donc définir cette propriété sur false pour rétablir le comportement de la version 2.6.1.

La valeur par défaut est true.

Certaines implémentations de stockage de mémoire cache du disque local prennent en charge le chiffrement des données stockées. La définition de cet indicateur sur true active le chiffrement des magasins locaux qui le prennent en charge.

Cet indicateur détermine si l’application doit réaliser une requête sur le magasin local lorsqu’il n’est pas connecté. Par défaut, lorsque l’adaptateur déconnecté est configuré pour prendre en charge l’exécution des requêtes dynamiques, l’appel de la méthode fill() n’entraîne pas l’interrogation du magasin local lorsque l’application n’est pas connectée. Si l’instance fallBackToLocalFill est définie sur true, le magasin local est également interrogé lorsque l’application est déconnectée.

Identificateur de cette instance DataStore. Cette propriété facultative est utilisée conjointement avec la configuration du cache pour identifier de façon unique cette instance DataStore. Cette valeur doit être indépendante de la session. Ainsi, vous ne devez pas créer cet identificateur lors de l’exécution à l’aide d’une méthode telle que UIDUtil.createUID(). Si cette valeur n’est pas affectée, elle est calculée en fonction des valeurs de configuration du serveur pour les canaux associés.

Indique si les modifications apportées aux collections gérées doivent être ignorées au lieu d’être communiquées au serveur lors d’une validation.

Indique quand cette instance DataStore est initialisée et prête à être utilisée. Cette propriété est nécessaire uniquement lorsque vous travaillez sur une application configurée à l’exécution ou sur une application nécessitant d’accéder à des données stockées sur disque dans un cache local.

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 .

Indique s’il existe des modifications en attente à fusionner.

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 .

Priorité par défaut des messages envoyés par l’instance DataStore. Les valeurs possibles sont les valeurs comprises entre 0 et 9 (0 correspondant à la priorité la plus faible), ainsi que -1, qui signifie que l’instance DataStore n’a pas de niveau de priorité attribué. Si un niveau de priorité est déjà défini pour le message, cette propriété est prioritaire par rapport à la valeur déjà définie.

Détermine si des modifications de serveur transférées sont en cours de fusion dans la vue des objets gérés du client. Cela peut se produire à tout moment lorsque la valeur de la propriété autoMerge est true. Si la valeur de la propriété autoMerge est false, cette propriété s’applique uniquement lorsque vous appelez explicitement la méthode merge. Grâce à cet indicateur, vous pouvez connaître la différence entre une modification de serveur asynchrone transférée et une modification réalisée par l’utilisateur dans vos méthodes définies.

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 .

Permet d’accéder au délai d’expiration des demandes d’une opération, en secondes. Une valeur égale ou inférieure à zéro empêche les délais d’attente de demande.

Lorsque le client reçoit une erreur traitant un message, le fait de définir cette propriété sur true provoque l’annulation de la validation des lots qui ont été validés, mais qui n’ont pas encore été envoyés au serveur. Si vous définissez la propriété commitQueueMode sur ONE_AT_A_TIME et cette propriété sur true, vous pouvez traiter les erreurs d’un seul lot à la fois. Sinon, vous pouvez recevoir les erreurs d’une série d’erreurs, ce qui risque de compliquer légèrement la résolution.

La valeur par défaut est false.

Cet intervalle de temps peut être configuré pour réduire la fréquence de la fréquence à laquelle la mémoire cache est enregistré. Lorsque la propriété autoSaveCache est définie surtrue, LiveCycle Data Services enregistre le cache après chaque modification. Si vous disposez d’une mémoire cache assez grande, cette opération peut s’avérer coûteuse. Vous pouvez donc réduire la fréquence à laquelle la mémoire cache est enregistrée. Si vous définissez cette propriété sur 1 000 millisecondes, la mémoire cache est enregistrée une fois par seconde.

La valeur par défaut est 0.

Indicateur pouvant être défini sur false pour rétablir le comportement de LiveCycle Data Services 2.6, qui consistait à journaliser les erreurs en cas de modification de la propriété UID, mais sans envoyer d’erreur.

La valeur par défaut est true.

Liste des instances MessageBatch qui ne sont pas validées. Pour préserver l’intégrité des données, il convient en règle générale de ne pas modifier l’ordre des opérations. Par conséquent, cette liste est en lecture seule. Pour créer un nouveau lot, appelez la méthode createBatch(). Cette méthode ajoute un nouveau lot à la fin de la liste uncommittedBatches, dont le dernier élément est désigné comme lot currentBatch.

Ces propriétés pouvant être liées, vous pouvez examiner l’indicateur commitRequired d’un lot spécifique pour savoir s’il contient des modifications ou établir une liaison avec la propriété items pour obtenir la liste des instances MessageCacheItem en attente de validation dans ce lot.

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 .

Normalement, une instance DataStore est créée automatiquement, mais vous pouvez créer votre propre instance DataStore et l’affecter manuellement à la propriété dataStore d’une instance DataService. Pour ce faire, vous devez faire en sorte que tous les services de données partageant le même magasin de données utilisent le même ensemble de canaux et que la valeur de leur paramètre de configuration use-transactions soit identique. Utilisez ce constructeur pour créer une instance DataStore dont le paramètre destination contient la destination de l’une des instances DataService utilisant ce magasin de données. Ce constructeur sert uniquement à recherche l’ensemble de canaux. Vous devez également indiquer la valeur de l’indicateur use-transactions de ce magasin de données.

Valide les modifications en attente pour les collections et éléments gérés par cette instance DataStore. Lorsque la valeur de la propriété autoCommit est true, les transactions ne sont pas utilisées et il n’est pas nécessaire d’appeler cette méthode. Pour utiliser des transactions, définissez la propriété autoCommit sur false et appelez cette méthode directement pour valider un lot de modifications. En général, vous appelez simplement « commit() » sans utiliser d’argument, ce qui provoque la validation de toutes les modifications en attente. Vous pouvez spécifier des arguments facultatifs pour valider un sous-ensemble des modifications en attente.

Vous devez résoudre tous les conflits en attente avant de valider les modifications apportées à un élément de l’instance DataStore.

Si l’assembleur est configuré de telle sorte que la propriété use-transactions est définie sur true, toutes les modifications sont validées de façon atomique. Si une opération échoue, aucune des opérations du lot n’est appliquée. Si la propriété use-transactions est définie sur false, les opérations sont validées une à une jusqu’à ce qu’un échec se produise, ce qui a pour effet d’arrêter le traitement. Les modifications intervenant avant l’erreur sont appliquées, mais celles qui interviennent après l’erreur ne le sont pas. Lorsqu’une erreur se produit dans le cadre du traitement d’un lot, les modifications sont replacées dans la file d’attente des modifications non validées. Si vous souhaitez supprimer les modifications qui ont provoqué l’erreur, vous devez appeler la méthode revertChanges.

Par défaut, la méthode de validation valide toutes les modifications en attente pour tous les éléments créés, modifiés et supprimés dans cette instance DataStore. Si vous souhaitez valider un sous-ensemble de ces modifications, vous pouvez spécifier une combinaison d’instances ArrayCollection et/ou d’éléments gérés qui définissent le sous-ensemble de modifications à inclure dans le lot. Pour chaque collection de tableaux spécifiée, toutes les modifications de l’appartenance ou de l’ordre des éléments de cette collection, ainsi que les modifications portant sur les éléments de cette collection eux-mêmes sont validées. Vous pouvez également spécifier une liste d’éléments gérés individuels, de sorte que seules les modifications concernant ces éléments soient validées. Si vous spécifiez dans le paramètre itemsOrCollections des objets qui ne sont pas des collections ou des éléments gérés, une erreur DataServiceError est envoyée.

Si vous utilisez le paramètre itemsOrCollections et que les propriétés d’association des éléments font référence à d’autres éléments, vous pouvez utiliser le paramètre cascadeCommit pour définir si les modifications apportées aux éléments associés doivent ou non être incluses dans le lot. Par exemple, si vous spécifiez un élément Group dans le paramètre items et que la propriété members d’une instance Group fait référence à une liste d’instances Person alors que la valeur de cascadeCommit est true, les modifications apportées à une instance Person seront également incluses dans l’ensemble de modifications validées. Si la valeur de cascadeCommit est false, seules les modifications apportées à l’instance Group sont incluses. Utilisez cascadeCommit=true pour faire en sorte que toutes les modifications dépendantes soient incluses dans le lot.

Paramètres

Indique si des mises à jour sont en attente de validation sur un objet précis.

Paramètres

Force ce service à réaliser une tentative de connexion à la destination distante. Cette méthode peut être utilisée conjointement avec la propriété autoConnect et la méthode disconnect() pour contrôler l’état de la connexion.

Accepte les modifications spécifiées par cette opération, crée une nouvelle instance MessageBatch et positionne ce lot dans la liste uncommittedBatches. Si itemsOrCollection=null, l’intégralité de l’ensemble de messages de la propriété currentBatch est replacée dans le nouveau lot et un nouveau lot est créé et défini comme lot currentBatch. Appelez cette méthode lorsque vous souhaitez partitionner un ensemble de modifications pour marquer différentes actions pouvant être validées ou rétablies en bloc. Par exemple, si vous créez un objet parent et un enfant associé à ce parent, vous pouvez ensuite appeler la méthode createBatch() pour placer ces deux modifications dans un groupe. Si vous le faites à deux reprises, vous obtiendrez deux lots, chacun créant un parent et un enfant. Vous pouvez ensuite valider chaque groupe de modifications indépendamment, à condition qu’ils soient validés dans l’ordre dans lequel les lots ont été créés. Vous pouvez également rétablir le lot le plus récent afin de laisser le premier lot inchangé. Ainsi, vous pouvez mettre en place un système simple d’annulation à plusieurs niveaux, en appelant tout simplement createBatch(null) après chaque opération.

Vous pouvez marquer un lot en utilisant un ensemble de propriétés définies par l’utilisateur, par le biais de la propriété MessageBatch.properties (ou de l’argument properties de cette méthode). Ces informations sont enregistrées et restaurées dans le lot lors de l’utilisation de la fonctionnalité hors ligne et elles peuvent être utilisées pour identifier le lot sur le client. Les valeurs placées ici doivent pouvoir être sérialisées (objets ou classes avec [RemoteClass]).

Si vous spécifiez une valeur pour le paramètre itemsOrCollection, un nouveau lot est créé. Il contient uniquement les modifications qui concernent l’élément ou la collection d’éléments. Si vous définissez cascadeCommit sur true, les modifications des éléments associés sont également incluses dans l’ensemble de messages placé dans le nouveau lot.

Paramètres

Force tous les services de données utilisant ce magasin de données à se déconnecter.

Cette méthode remplit l’instance ListCollectionView spécifiée en utilisant tous les identificateurs de cache précédemment utilisés dans l’application.

Paramètres

Initialise l’instance DataStore qui implique l’initialisation des métadonnées de toutes les instances ConcreteDataService associées. En cas de réussite ou d’échec, le rappel approprié est invoqué. Si le magasin de données est déjà initialisé, le rappel en cas de réussite est immédiatement invoqué. Les rappels doivent être des fonctions sans paramètre.

Paramètres

Déconnecte l’utilisation de la destination actuelle. Le fait d’appeler cette méthode déconnecte toutes les instances DataService associées.

Fusionne les mises à jour en attente dans l’ensemble d’objets géré. Le processus de fusion des modifications peut détecter des conflits.

Récupère à nouveau toutes les données gérées sur le client.

Libère toutes les données gérées sur le client. Cette opération libère l’élément et les caches de requêtes du client pour toutes les données et résilie les abonnements liés à la synchronisation automatique des données sur le serveur.

Paramètres

Rétablit toutes les modifications en attente (non validées) pour toutes les instances DataService gérées par cette instance DataStore.

Rétablit toutes les modifications en attente (non validées) pour les éléments de la collection gérée spécifiée.

Paramètres

Définit les informations d’identification de cette destination DataStore.

Paramètres

Définit les informations d’identification du tiers de cette destination DataStore.

Paramètres

Distribué lorsqu’un conflit entre des modifications locales en attente sur ce client et des modifications demandées par un autre client est détecté, ou lorsque des modifications demandées par ce client détectent une erreur de conflit au niveau de la destination distante. L’instance DataStore distribue les événements de conflit de toutes les destinations partageant l’instance DataStore, mais vous pouvez également écouter les événements de conflit d’un type particulier sur une instance DataService. Utilisez l’instance DataStore lorsque vous disposez d’un objet présentant des associations, car dans ce cas, il peut être nécessaire de résoudre les conflits dans un ordre particulier pour maintenir l’intégrité de ces associations.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

L’événement FaultEvent.FAULT est distribué lorsque l’appel de la méthode commit renvoie une erreur.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

L’événement ResultEvent.RESULT est distribué lorsqu’un appel de la méthode commit aboutit à un retour.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

Impose une vérification des dépendances simples entre les lots en attente et le prochain lot à valider.

Impose l’envoi immédiat du deuxième lot, sans vérification préalable des dépendances.

Impose un délai entre la fin de la validation d’un lot et le début de la validation d’un nouveau lot.