The plug-in interface for IReadSemesterHandler is used by IPSIS adapters to support the read operation for Semesters.
The interface implementation is D2L.IM.IPSIS.OrgUnits.Semesters.Handlers.IReadSemesterHandler.
The following configuration lists provide a starting point for any IPSIS implementation:
IPSIS, Template - Semester
- ReadSemesterIMHandler (Sort Order = 10)
- ReadSemesterValidateHandler (Sort Order = 20)
ReadSemesterIMHandler
Implementation
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReadSemesterIMHandler
Expected behavior
- Attempts to read all information stored in the IM tables for the requested Semester.
- If no record is found, the handler throws a DataNotFoundException.
Configuration note
This handler should be configured at the beginning of the list, before any Validate handlers.
ReadSemesterLMSHandler
Implementation
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReadSemesterLMSHandler
Expected behavior
The handler performs the following tasks:
- Retrieves all OrgUnit mappings for the given Semester.
- If no mappings are found, the handler throws a DataNotFoundException.
- If one or more mappings exist, the handler looks up the LMS OrgUnit from the first available mapping and return details of this OrgUnit.
- Otherwise, the handler throws an InvalidOrgUnitException.
Configuration note
This handler should be configured after the ReadIM handler, and before any Validate handlers.
ReadSemesterValidateHandler
Implementation
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.ReadSemesterValidateHandler
Expected behavior
The handler ensures that the retrieved OrgUnit is actually a Semester.
Configuration note
This handler should be configured after ReadIM and ReadLMS (if present).