$doc.setState

Description

Modifie l'état du dossier.

Syntaxe

$doc.setState( context , state [, 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.

state string

Nom de l'état à atteindre

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.

force boolean

Flag indiquant de faire un changement d'état en force. Cela désactive les contrôles habituellement effectués par le moteur, à savoir la vérification d'existence de l'état dans le modèle d'états et le contrôle d'existence d'une transition permettant de passer de l'état actuel à l'état donné. Il n'est par conséquent pas recommandé d'activer ce flag.

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).

events boolean / array / string

Cette valeur permet de gérer l'exécution des événements. Pour rappel, les événements sont les notifications onenter et onleave déclarées au niveau des états, c'est-à-dire des éléments <state> du modèle d'états (fichier states.xml).

La valeur peut avoir différentes formes:

• valeur booléenne (true/false): sous cette forme, la propriété indique d'activer (valeur true) ou d'ignorer (valeur false) tous les événements
• chaîne de caractères: ce format permet d'indiquer quel(s) événements activer. Les événements reconnus sont onenter, onleave, ou une combinaison des deux (séparés par une virgule ou un espace).
• tableau de String: la méthode s'attend à retrouver les noms d'événements à déclencher en valeurs du tableau

La valeur par défaut est true.

Retour

Retourne la valeur true si le changement d'état a réussi ou false en cas d'erreur.

Exemple

Non disponible