De plug-in-interface voor IReplaceDepartmentHandler wordt door IPSIS-adapters gebruikt ter ondersteuning van het vervangen van afdelingen.
De interface-implementatie is D2L.IM.IPSIS.OrgUnits.Departments.Handlers.IReplaceDepartmentHandler.
De configuratielijsten IPSIS, Sjabloon - Afdeling bieden een startpunt voor elke IPSIS-implementatie.
De volgende lijst met handlers wordt als startpunt gebruikt:
- ReplaceDepartmentReadHandler (sorteervolgorde = 10)
- ReplaceDepartmentValidateHandler (sorteervolgorde = 20)
- ReplaceDepartmentCreateLMSHandler (sorteervolgorde = 30)
- ReplaceDepartmentCreateIMHandler (sorteervolgorde = 40)
- ReplaceDepartmentSaveLMSHandler (sorteervolgorde = 50)
- ReplaceDepartmentSaveIMHandler (sorteervolgorde = 60)
ReplaceDepartmentReadHandler
De ReplaceDepartmentReadHandler leest alle informatie met betrekking tot de afdeling die bestaat in de LMS- of IM-tabellen van de database voor gebruik in andere handlers.
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Departmentss.Handlers.ReplaceDepartmentReadHandler®
Verwacht gedrag
De handler voert de volgende taken uit:
- Probeert om informatie over de afdeling te lezen uit de IM-tabellen:
- De handler probeert alle gevonden toewijzingen aan het LMS voor de afdeling te lezen.
- De handler probeert alle gevonden informatie over de afdeling te lezen vanuit het LMS.
- Probeert informatie over een aangegeven bovenliggende organisatie-eenheid te lezen uit de IM-tabellen.
- Als er geen informatie wordt gevonden, stelt de handler de standaard bovenliggende lijst van de organisatie in op het enige bovenliggende item.
- 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.
ReplaceDepartmentValidateHandler
De ReplaceDepartmentValidateHandler zorgt ervoor dat een geldige code en naam aan de afdeling worden toegewezen.
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReplaceDepartmentValidateHandler®
Verwacht gedrag
De handler voert de volgende taken uit:
- De Validate-handler controleert of er zowel een code als een naam voor de aanvraag zijn opgegeven. De waarden Code en Naam moeten tekenreeksen zijn met een lengte groter dan 0. Als Code of Naam null of leeg is, genereert de handler een ArgumentNullException en worden alle bewerkingen van de handler gestopt.
- De Validate-handler controleert ook of de aanvraag niet probeert het type van een bestaande organisatie-eenheid te wijzigen (bijvoorbeeld een College in een Afdeling).
- 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.
ReplaceDepartmentParentsNoUpdateLMSHandler
De ReplaceDepartmentParentsNoUpdateLMSHandler haalt de bovenliggende organisatie-eenheden op die handmatig in het educatief beheersysteem zijn gemaakt en houdt de relatie vast zodat deze niet wordt overschreven door deze updatebewerking.
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReplaceDepartmentParentsNoUpdateLMSHandler®
Verwacht gedrag
De handler voert de volgende taken uit:
- Haalt alle bovenliggende onderdelen van de afdeling op en werkt de lijst met bovenliggende onderdelen bij.
- De verwerking gaat door naar de volgende handler (retourneert True).
Foutgedrag
Er worden geen fouten gegenereerd voor dit omzettingsprogramma.
Opmerking over de configuratie
- Deze handler moet plaatsvinden na de Read- en Validate-handlers.
- Deze handler moet plaatsvinden vóór de Save-handlers.
- Aanbevolen sorteervolgorde = 3.
ReplaceDepartmentCreateLMSHandler
De ReplaceDepartmentCreateLMSHandler maakt de afdeling in Brightspace®.
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReplaceDepartmentCreateLMSHandler®
Verwacht gedrag
Deze handler wordt alleen uitgevoerd als er geen Brightspace®-afdelingen aan de aanvraag zijn gekoppeld. De handler voert de volgende taken uit:
- Hiermee wordt de Brightspace®-afdeling gemaakt met behulp van de informatie die in de aanvraag wordt doorgegeven (waardoor automatische registratie in het controlelogboek 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 er een probleem was met de verwerking, wordt er een uitzondering gegenereerd, samen met alle gedetailleerde informatie die beschikbaar is.
Opmerkingen over de configuratie
- Deze handler wordt na eventuele Validate-handlers geplaatst.
- De Create LMS-handler moet vóór de IM-handler maken worden uitgevoerd.
ReplaceDepartmentCreateIMHandler
De ReplaceDepartmentCreateIMHandler maakt de entiteit in de IM-tabellen en maakt ook een toewijzing als een entiteit is gedefinieerd.
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReplaceDepartmentCreateIMHandler®
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 de afdeling in het IM-platform gemaakt.
- Als er een organisatie-eenheid voor het educatief beheersysteem aan de aanvraag is gekoppeld, maakt de handler de afdelingstoewijzing voor het IM-platform voor de LMS-afdeling.
- 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 er een probleem was met de verwerking, wordt er een uitzondering gegenereerd, samen met alle gedetailleerde informatie die beschikbaar is.
Opmerking over de configuratie
Deze handler moet na een LMS Create-handler worden geplaatst.
ReplaceDepartmentSaveLMSHandler
De ReplaceDepartmentSaveLMSHandler slaat alle wijzigingen op die zijn aangebracht in de Brightspace®-afdeling.
Implementatie
Deze handler wordt alleen uitgevoerd als er wijzigingen moeten worden opgeslagen voor de Brightspace®-afdeling. De handler voert de volgende taken uit:
- Werkt de Brightspace®-afdeling bij (waarbij 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 Create-handlers geplaatst.
ReplaceDepartmentSaveIMHandler
De ReplaceDepartmentSaveIMHandler slaat alle wijzigingen op die zijn aangebracht in IM-entiteit en -toewijzingen.
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReplaceDepartmentSaveIMHandler®
Verwacht gedrag
De 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 wordt na iedere SaveLMS-handler geplaatst.
ReplaceDepartementMapByCodeHandler
Deze handler koppelt een afdeling aan een bestaande Brightspace®-afdeling door te matchen op OrgUnitCode.
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReplaceDepartmentMapByCodeHandler®
Verwacht gedrag
Deze handler mag alleen worden gebruikt als de code van de organisatie-eenheid binnen een organisatie naar verwachting uniek is. De handler voert de volgende taken uit:
- Als er geen afdelingstoewijzing is, probeert de handler een afdeling te vinden in Brightspace® die overeenkomt met OrgUnitCode.
- Als er een overeenkomst wordt gevonden, werkt de handler het aanvraagobject bij zodat dit de overeenkomende orgUnit bevat.
- Als er geen overeenkomst wordt gevonden, doet de handler niets.
- Als er meerdere overeenkomsten worden gevonden, meldt de handler een MultipleOrgUnitsFoundException, waardoor een fout wordt geretourneerd.
- De handler mag alleen worden gebruikt als de code van de organisatie-eenheid binnen een organisatie naar verwachting uniek is.
- De verwerking gaat door 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 afdeling kunnen vinden.
ReplaceDepartmentNameNoUpdateLMSHandler
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReplaceDepartmentCreateHandler®
Verwacht gedrag
De handler voert de volgende taken uit:
- Werkt 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 wordt vóór SaveLMS-handlers geplaatst.
ReplaceDepartmentValidateLMSOrgUnitExistsHandler
De ReplaceSemesterValidateLMSOrgUnitExistsHandler controleert of de organisatie-eenheid waarmee de aanvraag overeenkomt, is verwijderd uit Brightspace®.
Implementatie
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReplaceDepartmentValidateLMSOrgUnitExistsHandler®
Verwacht gedrag
De handler voert de volgende taken uit:
- Probeert de huidige organisatie-eenheid op te halen.
- Als de huidige organisatie-eenheid niet bestaat (de aanvraag is een 'create', of de organisatie-eenheid is verwijderd uit Brightspace®), 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 Brightspace®. Er wordt een updateOrgUnitFailedException gemeld.
- Deze uitzondering zorgt ervoor dat de LIS-service reageert met invaliddata. Dit werd beschouwd als de meest geschikte responscode voor deze situatie.
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, meestal als een van de eerste Validate-handlers.