Classe tâche (stereotype)
Les classes tâche sont des classes non persistantes dont la méthode Execute peut être exécutée comme une tâche.
Une classe tâche :
- Peut être utiliser comme une classe non persistante ordinaire.
- Peut être utiliser dans le gestionnaire de tâche.
- Peut être exécutée par la consommation d'un message de file d'attente.
Lorsque la gestion des tâches est configurée pour le dossier, une tâche peut :
- Etre exécutée en asynchrone.
- Etre déclenchée par un événement.
- Etre déclenchée par la fin d'une autre tâche.
- Etre planifiée.
Lorsqu'une tâche est exécutée dans le cadre d'une file d'attente :
- L'exécution de la tâche est enregistrée dans le journal des tâches.
- Un événement d'exécution de tâche est généré.
Sachant qu'une tâche peut être configurée pour être déclenchée par un événement, il est possible d'enchaîner le déclenchement de tâche :
Par exemple :
- Tâche 1 déclenchée par un événement métier.
- Tache 2 déclenchée par le succès de la tâche 1.
Le passage de paramètre entre tâches est possible en ajoutant ces paramètres au message déclencheur de la tâche (Voir l'exemple dans la méthode Execute).
Dans l'exemple précédent la suite d'événement est la suivante :
- Evénement métier.
- Exécution de tâche 1.
- Evénement métier, fin d'exécution de tâche 1.
- Exécution de tâche 2.
- Evénement métier, fin d'exécution de tâche 2.
Sommaire |
Attributs du stéréotype
| ResultAsync | Indique si l'exécution a été asynchrone. |
| ResultBool | Code de retour |
| ResultCode | Code de retour |
| ResultReason | Raison d'échec |
Méthode du stéréotype
| CreateTaskMessage | Retourne un message correspondant à la sérialisation de cette tâche |
| ExecuteTask | Exécute la tâche en asynchrone |
| ExecuteOnEvent | Exécute la tâche sur un évènement (une fois) |
| SubscribeToEvent | Abonne la tâche à un évènement |
| UnSubscribeFromEvent | Dèsabonne la tâche d'un évènement |
| Schedule | Planifie la tâche |
| UnSchedule | Supprime la planification de la tâche |
| GetMessages | Récupère la liste des messages de la tâche |
Méthode de classe du stéréotype
| OnTerminateID | Retourne l'identifiant de fin d'exécution de la tâche |
| OnTerminateSuccessID | Retourne l'identifiant de fin d'exécution avec succès de la tâche |
| OnTerminateFailedID | Retourne l'identifiant de fin d'exécution avec échec de la tâche |
| OnStartID | Retourne l'identifiant de début d'exécution de la tâche |
| Subscribe | Souscrit à un évènement (Version 11) |
| Schedule | Planifie la tâche (Version 11) |
Méthode d'interface
Une classe de type Tâche peut/doit supporter les méthodes suivantes :
| Nom | Fac/Obl | Usage |
|---|---|---|
| Execute | Obligatoire | Exécute la tâche |
| OnTerminate | Facultative | Méthode executée sur la fin de la tâche |
| OnSuccess | Facultative | Méthode executée sur succès |
| OnFailure | Facultative | Méthode executée sur échec |
| TaskID | Facultative | Retourne un identifiant unique pour cette tâche. |
| TaskName | Facultative | Retourne le nom de la tâche dans le journal. |
| TaskInfos | Facultative | Retourne les informations de la tâche dans le journal. |
| TaskTitle | Facultative | Retourne le titre de la tâche dans le journal. |
| TaskReference | Facultative | Retourne la référence de la tâche dans le journal. |
| EventNotification | Facultative | Créer un évènement de notification sur terminaison de la tâche |
Ces interfaces permettent de configurer la tâche :
| Nom | Usage |
|---|---|
| IsTaskConfigurable | Retourne True si la tâche est configurable |
| TaskFormConfiguration | Retourne le nom de l'écran de configuration de la tâche |
| isTaskConfigured | Indique si la configuration de la tâche est complète |
| TaskCategory | Retourne le nom de la catégorie de la tâche |
Exemple :
Voir aussi :
