$doc.close

Description

Ferme un dossier et force l'enregistrement des données en base de données. Le dossier fermé ne sera plus affiché au refresh de l'interface.

Quand fermer un dossier ?

Il n'est pas nécessaire de fermer un dossier lorsqu'on envisage de le rouvrir par la suite. Cela est même déconseillé pour des raisons de performance et de fonctionnement, comme mentionné dans la note liée au paramètre documentMode du fichier de config.

En effet, le moteur est capable de gérer plusieurs ouverts à la fois, même lorsque le documentMode est défini en singledans la config.

Syntaxe

$doc.close( context [ , options ] )

Paramètres

context string / map

Object décrivant le contexte. Le paramètre peut désigner soit un contexte (exprimé en tant que string en clair, p.ex. "vendeur[123]" ou sous forme de hash) ou un map décrivant le contexte. Dans ce cas, le map doit a minima contenir une valeur pour les propriétés modelName et docId.

options map

Map d'options relatives à l'ouverture de dossier. Les options reconnues sont:

updateContext boolean

Flag true/false indiquant si la méthode doit mettre à jour le contexte avec le dossier courant. Si true, le contexte est mis à jour, pour autant que le dossier peut être fermé. L'option est true par défaut.

flush boolean

Flag true/false indiquant si les données doivent être flushées en DB avant la fermeture. Le flag est activé par défaut.

ignorePolicies boolean

Flag indiquant de ne pas tenir compte des policies lors du traitement.

Par défaut, les policies sont vérifiées si l'application gère des policies et si le thread courant est un thread "client", c'est-à-dire un thread initié par une requête du client. Si la méthode est invoquée par un script démarré par le scheduler, les policies ne seront pas vérifiées par défaut.

notify boolean

Flag true/false indiquant si le moteur doit déclencher la notification doc-close. Par défaut le flag est false.

Voir la description détaillée dans la documentation de la méthode $doc.create.

notificationParams map

Paramètres supplémentaires à passer lors de la notification doc-close. N'est pris en compte que lorsque notify est true.

Le paramètre attendu est un map de clés-valeurs. Les clés modelName et docId sont réservées et renseignées automatiquement par la méthode.

Le fait de spécifier des paramètres de notification active automatiquement l'option notify (pour autant qu'elle ne soit pas explicitement définir à false).

Retour

La méthode retourne la valeur true si le dossier a pu être fermé correctement, ou false si le dossier est déjà fermé.

Exemple

Non disponible