Classe tâche (stereotype)

De Wiki1000
(Différences entre les versions)
(→Méthode d'interface)
(→Méthode de classe du stéréotype)
 
(35 révisions intermédiaires par un utilisateur sont masquées)
Ligne 1 : Ligne 1 :
−
{{latest}}
+
{{Version900}}
  
 
Les classes tâche sont des classes non persistantes dont la méthode Execute peut être exécutée comme une tâche.
 
Les classes tâche sont des classes non persistantes dont la méthode Execute peut être exécutée comme une tâche.
Ligne 5 : Ligne 5 :
 
Une classe tâche :
 
Une classe tâche :
 
* Peut être utiliser comme une classe non persistante ordinaire.
 
* Peut être utiliser comme une classe non persistante ordinaire.
−
* Peut être configurée dans le gestionnaire de tâche.
+
* Peut être utiliser dans le gestionnaire de tâche.
 
* Peut être exécutée par la consommation d'un message de file d'attente.
 
* 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 :
 
Lorsqu'une tâche est exécutée dans le cadre d'une file d'attente :
Ligne 31 : Ligne 37 :
 
===Attributs du stéréotype===
 
===Attributs du stéréotype===
 
{|class="wikitable"
 
{|class="wikitable"
 +
|-
 +
|[[ResultAsync (TitTask)|ResultAsync]]
 +
|Indique si l'exécution a été asynchrone.
 +
|-
 +
|[[ResultBool (TitTask)|ResultBool]]
 +
|Code de retour
 +
|-
 +
|[[ResultCode (TitTask)|ResultCode]]
 +
|Code de retour
 +
|-
 +
|[[ResultReason (TitTask)|ResultReason]]
 +
|Raison d'échec
 
|}
 
|}
  
Ligne 38 : Ligne 56 :
 
|[[CreateTaskMessage (TitTask)|CreateTaskMessage]]
 
|[[CreateTaskMessage (TitTask)|CreateTaskMessage]]
 
|Retourne un message correspondant à la sérialisation de cette tâche
 
|Retourne un message correspondant à la sérialisation de cette tâche
 +
|-
 +
|[[ExecuteTask (TitTask)|ExecuteTask]]
 +
|Exécute la tâche en asynchrone
 +
|-
 +
|[[ExecuteOnEvent (TitTask)|ExecuteOnEvent]]
 +
|Exécute la tâche sur un évènement (une fois)
 +
|-
 +
|[[SubscribeToEvent (TitTask)|SubscribeToEvent]]
 +
|Abonne la tâche à un évènement
 +
|-
 +
|[[UnSubscribeFromEvent (TitTask)|UnSubscribeFromEvent]]
 +
|Dèsabonne la tâche d'un évènement
 +
|-
 +
|[[Schedule (TitTask)|Schedule]]
 +
|Planifie la tâche
 +
|-
 +
|[[UnSchedule (TitTask)|UnSchedule]]
 +
|Supprime la planification de la tâche
 +
|-
 +
|[[GetMessages (TitTask)|GetMessages]]
 +
|Récupère la liste des messages de la tâche
 +
|}
 +
 +
===Méthode de classe du stéréotype===
 +
{|class="wikitable"
 +
|-
 +
|[[OnTerminateID (TitTask)|OnTerminateID]]
 +
|Retourne l'identifiant de fin d'exécution de la tâche
 +
|-
 +
|[[OnTerminateSuccessID (TitTask)|OnTerminateSuccessID]]
 +
|Retourne l'identifiant de fin d'exécution avec succès de la tâche
 +
|-
 +
|[[OnTerminateFailedID (TitTask)|OnTerminateFailedID]]
 +
|Retourne l'identifiant de fin d'exécution avec échec de la tâche
 +
|-
 +
|[[OnStartID (TitTask)|OnStartID]]
 +
|Retourne l'identifiant de début d'exécution de la tâche
 +
|-
 +
|[[TTask.Subscribe (TitTask)|Subscribe]]
 +
|Souscrit à un évènement {{Version1100}}
 +
|-
 +
|[[TTask.Schedule (TitTask)|Schedule]]
 +
|Planifie la tâche {{Version1100}}
 
|}
 
|}
  
Ligne 43 : Ligne 104 :
 
Une classe de type Tâche peut/doit supporter les méthodes suivantes :
 
Une classe de type Tâche peut/doit supporter les méthodes suivantes :
 
{|class="wikitable"
 
{|class="wikitable"
 +
|-
 +
!Nom
 +
!Fac/Obl
 +
!Usage
 
|-
 
|-
 
|[[Executee (TitTask)|Execute]]
 
|[[Executee (TitTask)|Execute]]
Ligne 48 : Ligne 113 :
 
|Exécute la tâche
 
|Exécute la tâche
 
|-
 
|-
−
|[[isTaskConfigured (TitTask)|isTaskConfigured]]
+
|[[OnTerminate (TitTask)|OnTerminate]]
 
|Facultative
 
|Facultative
−
|Indique si la configuration de la tâche est complète
+
|Méthode executée sur la fin de la tâche
 +
|-
 +
|[[OnSuccess (TitTask)|OnSuccess]]
 +
|Facultative
 +
|Méthode executée sur succès
 
|-
 
|-
 
|[[OnFailure (TitTask)|OnFailure]]
 
|[[OnFailure (TitTask)|OnFailure]]
 
|Facultative
 
|Facultative
 
|Méthode executée sur échec
 
|Méthode executée sur échec
 +
|-
 +
|[[TaskID (TitTask)|TaskID]]
 +
|Facultative
 +
|Retourne un identifiant unique pour cette tâche.
 +
|-
 +
|[[TaskName (TitTask)|TaskName]]
 +
|Facultative
 +
|Retourne le nom de la tâche dans le journal.
 +
|-
 +
|[[TaskInfos (TitTask)|TaskInfos]]
 +
|Facultative
 +
|Retourne les informations de la tâche dans le journal.
 +
|-
 +
|[[TaskTitle (TitTask)|TaskTitle]]
 +
|Facultative
 +
|Retourne le titre de la tâche dans le journal.
 +
|-
 +
|[[TaskReference (TitTask)|TaskReference]]
 +
|Facultative
 +
|Retourne la référence de la tâche dans le journal.
 +
|-
 +
|[[EventNotification (TitTask)|EventNotification]]
 +
|Facultative
 +
|Créer un évènement de notification sur terminaison de la tâche
 +
|}
 +
 +
Ces interfaces permettent de configurer la tâche :
 +
 +
{|class="wikitable"
 +
|-
 +
!Nom
 +
!Usage
 +
|-
 +
|[[IsTaskConfigurable (TitTask)|IsTaskConfigurable]]
 +
|Retourne True si la tâche est configurable
 +
|-
 +
|[[TaskFormConfiguration (TitTask)|TaskFormConfiguration]]
 +
|Retourne le nom de l'écran de configuration de la tâche
 +
|-
 +
|[[isTaskConfigured (TitTask)|isTaskConfigured]]
 +
|Indique si la configuration de la tâche est complète
 +
|-
 +
|[[TaskCategory (TitTask)|TaskCategory]]
 +
|Retourne le nom de la catégorie de la tâche
 
|}
 
|}
  
Ligne 63 : Ligne 176 :
  
 
* [[TdbmQueueMessage|Message de file d'attente]]
 
* [[TdbmQueueMessage|Message de file d'attente]]
 +
* [[TdbmMessageTaskLog (class)|Journal d'exécution des tâches]]
 +
* [[Création d'une tâche configurable (Task)|Création d'une tâche configurable]]
 +
* [[Création d'un callback de tâche (task)|Création d'un callback de tâche]]
  
 
[[Category:Stereotype]]
 
[[Category:Stereotype]]
 
[[Category:Stéréotype tâche]]
 
[[Category:Stéréotype tâche]]
−
[[Category:Latest]]
+
[[Category:File d'attente]]
 +
[[Category:Version900]]

Version actuelle en date du 6 décembre 2022 à 17:20

version900-32x32.png

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 :





Whos here now:   Members 0   Guests 0   Bots & Crawlers 1
 
Récupérée de « https://frp.sage.fr/wiki1000/index.php?title=Classe_t%C3%A2che_(stereotype)&oldid=14325 »
Outils personnels