$doc.closeAll

Description

Ferme tous les dossiers ouverts dans la session, en forçant à chaque fois l'enregistrement des données en base de données.

Les dossiers fermés ne seront plus affichés au refresh de l'interface.

Syntaxe

$doc.closeAll( [ options ] )

Paramètres

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. Par défaut, la valeur du flag dépend des infos d'autoflush définies pour le modèle de dossier.

ignorePolicies boolean

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

Par défaut, le flag dépend du mode de gestion des dossiers: en mode "multi" il est à false et en mode "single" il est à true (une description des différents modes est donnée dans le chapitre documentMode).

Il est également par défaut à true si l'application n'a pas de policies ou si le thread n'est pas un thread initié par une requête du client. Ainsi un thread créé par le scheduler n'effectuera par défaut pas de vérification des policies.

notify boolean

Flag true/false indiquant si le moteur doit déclencher la notification doc-close. Par défaut le flag est false. Si activée, la notification est envoyée pour chaque dossier fermé.

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 true si, après exécution, il n'y a plus de dossier ouvert, sinon false.

Exemple

$doc.closeAll();