The plug-in interface for IReadDepartmentHandler is used by IPSIS Adapters to support the read operation for Departments.
The interface implementation is D2L.IM.IPSIS.OrgUnits.Departments.Handlers.IReadDepartmentHandler.
The IPSIS, Template - Department configuration lists provide a starting point for any IPSIS implementation.
The following handler list provides a starting point:
- ReadDepartmentIMHandler (Sort Order = 10)
- ReadDepartmentValidateHandler (Sort Order = 20)
ReadDepartmentIMHandler
Implementation
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReadDepartmentIMHandler
Expected behavior
Attempts to read all information stored in the IM tables for the requested Department.
Configuration note
This handler should be configured at the beginning of the list, before any Validate handlers.
ReadDepartmentLMSHandler
Implementation
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReadDepartmentLMSHandler
Expected behavior
The handler performs the following tasks:
- Retrieves all OrgUnit mappings for the given department.
- If no mapping is found, a DataNotFoundException is thrown.
- If one or more mappings exist, the handler looks up the LMS OrgUnit from the first available mapping and returns the details of the OrgUnit.
- Otherwise, an InvalidOrgUnitException is thrown.
Configuration note
This handler should be configured after the ReadIM handler, and before any Validate handlers.
ReadDepartmentValidateHandler
Implementation
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReadDepartmentValidateHandler
Expected behavior
Ensures that the retrieved OrgUnit is actually a Department.
Configuration note
This handler should be configured after ReadIM and ReadLMS (if present).