$doc.setView

Description

Change la vue courante d'un dossier.

Syntaxe

$doc.setView( context , view [, options ] )

Paramètres

context string / map

Object décrivant le contexte du dossier à traiter. Le paramètre peut désigner soit un contexte (exprimé en tant que string en clair, p.ex. "listeArticle[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 entrées modelName et docId.

view string

Nom de la vue à activer

options map

Map d'options. Les options reconnues sont:

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 les notifications doc-enterstate et doc-leavestate. 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 des notifications. 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, docId, prevState, nextState, allowStateChange et step 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

Retourne la valeur true si le changement de vue, sinon false.

Exemple

Non disponible