De plug-in-interface voor IReplaceSemesterHandler wordt door IPSIS-adapters gebruikt om het vervangen van semesters te ondersteunen.
De interface-implementatie D2L.IM.IPSIS.OrgUnits.Semesters.Handlers.IReplaceSemesterHandler.
De volgende configuratielijst biedt een startpunt voor elke IPSIS-implementatie:
Sjabloon - Semester, IPSIS
- ReplaceSemesterReadHandler (sorteervolgorde = 10)
- ReplaceSemesterValidateHandler (sorteervolgorde = 20)
- ReplaceSemesterCreateLMSHandler (sorteervolgorde = 30)
- ReplaceSemesterCreateIMHandler (sorteervolgorde = 40)
- ReplaceSemesterSaveLMSHandler (sorteervolgorde = 50)
- ReplaceSemesterSaveIMHandler (sorteervolgorde = 60)
ReplaceSemesterReadHandler
De ReplaceSemesterReadHandler leest alle informatie met betrekking tot het semester die bestaat in de LMS- of IM-tabellen van de database en die gebruikt moet worden in andere handlers.
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReplaceSemesterReadHandler®
Verwacht gedrag
De handler voert de volgende taken uit:
- Probeert informatie over het Semester te lezen uit de IM-tabellen. Als de informatie wordt gevonden, probeert de handler eventuele toewijzingen aan het LMS voor het Semester te lezen en wordt geprobeerd over het Semester van het LMS te lezen.
- Probeert informatie te lezen over enige aangegeven bovenliggende OrgUnits uit de IM-tabellen. Als er geen worden gevonden, stelt de handler de standaard bovenliggende lijst van de organisatie in op het enige bovenliggende onderdeel.
- De verwerking gaat door naar de volgende handler (retourneert True).
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerking over de configuratie
Een Read-handler moet plaatsvinden vóór Validate-handlers.
ReplaceSemesterValidateHandler
De ReplaceSemesterValidateHandler zorgt ervoor dat een geldige code en naam aan het semester worden toegewezen.
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReplaceSemesterValidateHandler®
Verwacht gedrag
De Validate-handler controleert of er zowel een code als een naam voor de aanvraag zijn opgegeven. Deze waarden moeten tekenreeksen zijn met een lengte groter dan 0. De handler voert de volgende taken uit:
- Als Code of Naam null of leeg is, genereert de handler een ArgumentNullException en worden alle bewerkingen van de handler gestopt.
- De validatiehandler controleert ook of de aanvraag niet probeert het type (bijvoorbeeld een college wijzigen in een afdeling) van een bestaande organisatie-eenheid te wijzigen. Als de aanvraag probeert het type te wijzigen, wordt een InvalidOperationException gegenereerd en worden alle bewerkingen van de handler gestopt.
- Als alles succesvol is, gaat de verwerking verder naar de volgende handler (retourneert True).
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerking over de configuratie
Validate-handlers moeten worden geconfigureerd vóór de Create-handler.
ReplaceSemesterCreateLMSHandler
De ReplaceSemesterCreateLMSHandler maakt het Semester in Brightspace®.
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReplaceSemesterCreateLMSHandler®
Verwacht gedrag
Deze handler wordt alleen uitgevoerd als er geen Semesters van Brightspace® aan de aanvraag zijn gekoppeld. De handler voert de volgende taken uit:
- Hiermee wordt het LMS-semester gemaakt met behulp van de informatie die in de aanvraag wordt doorgegeven (waardoor automatische registratie in het controlelogboek voor Semester maken wordt geactiveerd).
- Als alles succesvol is, stelt de handler de status van het resultaat in op EntityCreated.
- Als er een fout optreedt, stelt de handler de status van het resultaat in op CreateFailed.
- De verwerking gaat door naar de volgende handler (retourneert True).
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerkingen over de configuratie
- Deze handler moet na eventuele Validate-handlers worden geplaatst.
- De Create LMS-handler moet vóór de IM-handler maken worden uitgevoerd.
ReplaceSemesterCreateIMHandler
De ReplaceSemesterCreateIMHandler maakt de entiteit in de IM-tabellen en voert een toewijzing uit als er een is gedefinieerd.
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReplaceSemesterCreateIMHandler®
Verwacht gedrag
Deze handler wordt alleen uitgevoerd als er geen overeenkomende entiteit in de IM-tabellen is opgenomen. De handler voert de volgende taken uit:
- Hiermee wordt het semester op het IM-platform gemaakt.
- Als er een LMS OrgUnit aan de aanvraag is gekoppeld, maakt de handler de semestertoewijzing van het IM-platform aan het LMS-semester.
- Als alles succesvol is, stelt de handler de status van het resultaat in op EntityCreated.
- De verwerking gaat door naar de volgende handler (retourneert True).
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerking over de configuratie
Deze handler moet na CreateLMS-handlers worden geplaatst.
ReplaceSemesterSaveLMSHandler
De save-handler slaat alle wijzigingen op die zijn aangebracht in het LMS-semester.
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReplaceSemesterSaveLMSHandler®
Verwacht gedrag
Deze handler wordt alleen uitgevoerd als er wijzigingen zijn die moeten worden opgeslagen voor het LMS-semester. De handler voert de volgende taken uit:
- Werkt het LMS-semester bij (automatische registratie in het controlelogboek wordt geactiveerd).
- Als de aanvraag een update is en er ten minste één veld is gewijzigd, stelt de handler de status van het resultaat in op EntityUpdated.
- De verwerking gaat door naar de volgende handler (retourneert True).
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerking over de configuratie
Deze handler wordt na elke Create-handler geplaatst.
ReplaceSemesterSaveIMHandler
De Save-handler slaat alle wijzigingen op die zijn aangebracht in IM-entiteit en -toewijzingen.
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Semester.Handlers.ReplaceSemesterSaveIMHandler®
Verwacht gedrag
Deze handler wordt alleen uitgevoerd als er wijzigingen zijn die moeten worden opgeslagen voor de entiteit of hiërarchie in de IM-tabellen. De handler voert de volgende taken uit:
- Werkt de IM-entiteit bij als er wijzigingen in behandeling zijn.
- Werkt de hiërarchische relaties van de IM-entiteit bij als bovenliggende onderdelen zijn toegevoegd of verwijderd.
- De verwerking gaat door naar de volgende handler (retourneert True).
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerking over de configuratie
Deze handler zou na elke SaveLMS-handler worden geplaatst.
ReplaceSemesterMapByCodeHandler
De ReplaceSemesterMapByCodeHandler koppelt een semester aan een bestaand LMS-semester door te matchen op OrgUnitCode.
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReplaceSemesterMapByCodeHandler®
Verwacht gedrag
De handler voert de volgende taken uit:
- Als er geen semestertoewijzing is, probeert de handler een semester te vinden in het educatief beheersysteem dat matcht op OrgUnitCode
- Als er een overeenkomst wordt gevonden, werkt de handler het aanvraagobject bij zodat dit de overeenkomende orgUnit bevat. De handler mag alleen worden gebruikt als de code van de organisatie-eenheid binnen een organisatie naar verwachting uniek is.
- Gaat verder naar de volgende handler.
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerking over de configuratie
Deze handler wordt doorgaans tussen de Read-handlers en de Create-handlers geplaatst. In dat geval wordt deze handler alleen uitgevoerd als de Read-handlers geen toegewezen semester vinden.
ReplaceSemesterNameNoUpdateLMSHandler
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReplaceSemesterNoUpdateLMSHandler®
Verwacht gedrag
De handler voert de volgende taken uit:
- Werk het aanvraagobject bij om aan te geven dat de naam niet mag worden bijgewerkt.
- De verwerking gaat door naar de volgende handler (retourneert True).
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerking over de configuratie
Deze handler moet vóór enige SaveLMS-handlers worden geplaatst.
ReplaceSemesterValidateLMSOrgUnitExistsHandler
De ReplaceSemesterValidateLMSOrgUnitExistsHandler controleert of de organisatie-eenheid waarmee de aanvraag overeenkomt, is verwijderd in het LMS.
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReplaceSemesterValidateLMSOrgUnitExistsHandler®
Verwacht gedrag
De handler voert de volgende taken uit:
- Probeert de huidige organisatie-eenheid op te halen.
- Als de huidige organisatie-eenheid niet bestaat (ofwel de aanvraag is een 'create' ofwel de organisatie-eenheid is verwijderd uit het educatief beheersysteem (LMS)), probeert de handler de ExternalOrgUnitInfo voor de aanvraag op te halen.
- Als de ExternalOrgUnitInfo geldig is, is dit geen 'create' en is de organisatie-eenheid verwijderd uit het LMS. De handler genereert een UpdateOrgUnitFailedException. Deze uitzondering zorgt ervoor dat de LIS-service reageert met invaliddata.
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerking over de configuratie
Deze handler wordt na de Read-handlers geplaatst, gewoonlijk als een van de eerste Validate-handlers.