$doc.getCancelReason¶

Description¶

Retourne la raison invoquée lors du dernier $doc.cancelStateTransition.

Pour comprendre l'utilité de cette méthode, prenons le scenario suivant:

1. Un script invoque $doc.setState
2. L'état visé possède une règles onenter="somecheck" au niveau du fichier d'état (dans le sous-dossier states)
3. Le script somecheck.ewts invoque $doc.cancelStateTransition avec la raison Ceci est un exemple.
4. Du fait de l'annulation, la méthode $doc.setState retourne false
5. On souhaite afficher une erreur à l'utilisateur pour donner la raison de l'échec du changement d'état. C'est ici qu'intervient $doc.getCancelReason.

Syntaxe¶

$doc.getCancelReason()

Retour¶

Reason invoquée lors du dernier appel à la méthode $doc.cancelStateTransition.

Exemple¶

Non disponible