L'interface du gestionnaire IReplaceSemesterHandler est utilisée par les adaptateurs IPSIS pour prendre en charge l'opération de remplacement pour les semestres.
La mise en œuvre de l'interface est D2L.IM.IPSIS.OrgUnits.Semesters.Handlers.IReplaceSemesterHandler.
La liste de configuration suivante offre un point de départ pour toute mise en œuvre IPSIS :
IPSIS, Template – Semester
- ReplaceSemesterReadHandler (Sort Order = 10)
- ReplaceSemesterValidateHandler (Sort Order = 20)
- ReplaceSemesterCreateLMSHandler (Sort Order = 30)
- ReplaceSemesterCreateIMHandler (Sort Order = 40)
- ReplaceSemesterSaveLMSHandler (Sort Order = 50)
- ReplaceSemesterSaveIMHandler (Sort Order = 60)
ReplaceSemesterReadHandler
Le gestionnaire ReplaceSemesterReadHandler lit toutes les informations relatives au semestre stockées dans les tableaux LMS (SGA) ou IM de la base de données à des fins d'utilisation par les gestionnaires ultérieurs.
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReplaceSemesterReadHandler
Comportement prévu
Ce gestionnaire effectue les tâches suivantes :
- Tente de lire les informations relatives au semestre dans les tableaux IM. S'il en trouve, il tente de lire toute correspondance au SGA pour le semestre, ainsi que les informations relatives au semestre dans les tableaux du SGA.
- Tente de lire les informations relatives à toute unité organisationnelle primaire indiquée dans les tableaux IM. Si aucune information n'y figure, le gestionnaire définit la liste des nœuds primaires par défaut de l'organisation comme unique UO primaire.
- Le traitement est cédé au prochain gestionnaire (renvoi de la valeur True [vrai]).
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Note de configuration
Un gestionnaire de lecture devrait s'exécuter avant un gestionnaire de validation.
ReplaceSemesterValidateHandler
Le gestionnaire ReplaceSemesterValidateHandler vérifie qu'un nom et qu'un code valides sont affectés au semestre.
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReplaceSemesterValidateHandler
Comportement prévu
Vérifie qu'un code et qu'un nom sont précisés pour la requête. Ces valeurs doivent être des chaînes d'une longueur supérieure à 0. Ce gestionnaire effectue les tâches suivantes :
- Si les champs de code ou de nom affichent une valeur nulle ou vide, le gestionnaire génère une exception ArgumentNullException et interrompt tout le traitement.
- Le gestionnaire de validation s'assure également que la requête ne tente pas de modifier le type (p. ex., Collège à Département) d'une unité organisationnelle existante. Si la requête tente de modifier le type, le gestionnaire génère une exception InvalidOperationException et le traitement est interrompu.
- Si toutes les étapes aboutissent, le traitement est cédé au prochain gestionnaire (renvoi d'une valeur True [vrai]).
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Note de configuration
Les gestionnaires de validation devraient être configurés de façon à s'exécuter avant le gestionnaire de création.
ReplaceSemesterCreateLMSHandler
Le gestionnaire ReplaceSemesterCreateLMSHandler crée le semestre dans Brightspace.
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReplaceSemesterCreateLMSHandler
Comportement prévu
Ce gestionnaire ne s’exécute que si aucun semestre existant de Brightspace n’est associé à la requête. Ce gestionnaire effectue les tâches suivantes :
- Crée le semestre du SGA à l'aide des informations transmises dans la requête (ce qui génère automatiquement une entrée de création de semestre dans le journal de vérification).
- Si toutes les étapes aboutissent, le gestionnaire attribue l'état EntityCreated au résultat.
- Si une erreur survient, le gestionnaire attribue l'état CreateFailed au résultat.
- Le traitement est cédé au prochain gestionnaire (renvoi de la valeur True [vrai]).
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Notes de configuration
- Ce gestionnaire devrait être placé après tout gestionnaire de validation.
- Le gestionnaire CreateLMS devrait précéder le gestionnaire CreateIM.
ReplaceSemesterCreateIMHandler
Le gestionnaire ReplaceSemesterCreateIMHandler crée l'objet Entity (entité) dans les tableaux IM, et une correspondance si une entité est définie.
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReplaceSemesterCreateIMHandler
Comportement prévu
Ce gestionnaire ne s'exécute que si les tableaux IM ne comprennent aucun objet Entity correspondant. Ce gestionnaire effectue les tâches suivantes :
- Crée le semestre dans la plateforme IM.
- Si une UO du SGA est associée à la requête, le gestionnaire crée la correspondance de semestre de la plateforme IM au semestre du SGA.
- Si toutes les étapes aboutissent, le gestionnaire attribue l'état EntityCreated au résultat.
- Le traitement est cédé au prochain gestionnaire (renvoi de la valeur True [vrai]).
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Note de configuration
Ce gestionnaire doit être placé après tout gestionnaire CreateLMS.
ReplaceSemesterSaveLMSHandler
Le gestionnaire ReplaceSemesterSaveLMSHandler enregistre toute modification apportée au semestre dans le SGA.
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReplaceSemesterSaveLMSHandler
Comportement prévu
Ce gestionnaire ne s'exécute que si des modifications relatives au semestre du SGA doivent être enregistrées. Ce gestionnaire effectue les tâches suivantes :
- Actualise le semestre du SGA (ce qui génère automatiquement une entrée de vérification).
- Si la requête est une mise à jour et qu'au moins un champ a été modifié, le gestionnaire attribue l'état EntityUpdated au résultat.
- Le traitement est cédé au prochain gestionnaire (renvoi de la valeur True [vrai]).
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Note de configuration
Ce gestionnaire devrait être placé après tout gestionnaire de création.
ReplaceSemesterSaveIMHandler
Le gestionnaire ReplaceSemesterSaveIMHandler enregistre toute modification apportée à l'entité IM et aux correspondances.
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Semester.Handlers.ReplaceSemesterSaveIMHandler
Comportement prévu
Ce gestionnaire ne s'exécute que si des modifications relatives à l'entité ou à la hiérarchie dans les tableaux IM doivent être enregistrées. Ce gestionnaire effectue les tâches suivantes :
- Actualise l'entité IM si des modifications sont en cours.
- Actualise les relations de la hiérarchie de l'entité IM si des nœuds primaires ont été ajoutés ou supprimés.
- Le traitement est cédé au prochain gestionnaire (renvoi de la valeur True [vrai]).
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Note de configuration
Ce gestionnaire devrait être placé après tout gestionnaire SaveLMS.
ReplaceSemesterMapByCodeHandler
Le gestionnaire ReplaceSemesterMapByCodeHandler associe un semestre à un semestre existant du SGA en fonction des correspondances de code d'UO.
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReplaceSemesterMapByCodeHandler
Comportement prévu
Ce gestionnaire effectue les tâches suivantes :
- S'il n'existe aucune correspondance de semestre, le gestionnaire tente de trouver dans le SGA un semestre correspondant au code d'UO.
- S'il trouve une correspondance, le gestionnaire actualise la requête en fonction de la valeur d'UO. Ce gestionnaire ne devrait être utilisé que si le code d'unité organisationnelle devait s'avérer unique au sein d'une organisation.
- Le traitement est cédé au prochain gestionnaire.
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Note de configuration
Ce gestionnaire est généralement placé entre les gestionnaires de lecture et les gestionnaires de création, auquel cas il ne s'exécutera que si les gestionnaires de lecture ne réussissent pas à trouver un semestre correspondant.
ReplaceSemesterNameNoUpdateLMSHandler
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReplaceSemesterNoUpdateLMSHandler
Comportement prévu
Ce gestionnaire effectue les tâches suivantes :
- Actualise l'objet de requête pour indiquer que le nom ne doit pas être actualisé.
- Le traitement est cédé au prochain gestionnaire (renvoi de la valeur True [vrai]).
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Note de configuration
Ce gestionnaire devrait être placé avant tout gestionnaire SaveLMS.
ReplaceSemesterValidateLMSOrgUnitExistsHandler
Le gestionnaire ReplaceSemesterValidateLMSOrgUnitExistsHandler vérifie si l'unité organisationnelle à laquelle la requête correspond a été supprimée dans le SGA.
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReplaceSemesterValidateLMSOrgUnitExistsHandler
Comportement prévu
Ce gestionnaire effectue les tâches suivantes :
- Tente de récupérer l'unité organisationnelle actuelle.
- Si l'UO actuelle n'existe pas (la requête est une opération de création ou l'UO a été supprimée dans le SGA), le gestionnaire tente de récupérer la valeur de l'objet ExternalOrgUnitInfo de la requête.
- Si la valeur de l'objet ExternalOrgUnitInfo est valide, il ne s'agit pas d'une opération de création et l'UO a été supprimée dans le SGA. Le gestionnaire génère une exception UpdateOrgUnitFailedException. Cette exception pousse les services LIS à générer un code de données non valides.
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Note de configuration
Ce gestionnaire est placé après les gestionnaires de lecture, généralement comme l'un des premiers gestionnaires de validation.