The plug-in interface for IReadOrgUnitHandler is used by IPSIS Adapters to support the read operation for OrgUnits.
The interface implementation is D2L.IM.IPSIS.OrgUnits.IReadOrgUnitHandler.
The IPSIS, Template - OrgUnit configuration list provides a starting point for any IPSIS implementation.
The following handler list is used as a starting point:
- ReadOrgUnitIMHandler (Sort Order = 10)
- ReadOrgUnitValidateHandler (Sort Order = 20)
ReadOrgUnitIMHandler
Implementation
D2L.IM.IPSIS.Default.OrgUnits.ReadOrgUnitIMHandler
Expected behavior
The handler performs the following tasks:
- Retrieves all information from the IPSIS tables for the given OrgUnit.
- 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.
ReadOrgUnitLMSHandler
Implementation
D2L.IM.IPSIS.Default.OrgUnits.ReadOrgUnitLMSHandler
Expected behavior
The handler performs the following tasks:
- Retrieves all OrgUnit mappings for the given OrgUnit.
- If no mapping is found, the handler throws a DataNotFoundException.
- If one or more mappings exist, the handler looks up the OrgUnit from the first available mapping and returns 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.
ReadOrgUnitValidateHandler
Implementation
D2L.IM.IPSIS.Default.OrgUnits.ReadOrgUnitValidateHandler
Expected behavior
Ensures that the retrieved OrgUnit has the expected OrgUnitType.
Configuration note
This handler should be configured after ReadIM and ReadLMS (if present).