The plug-in interface for IDeleteSemesterHandler is used by IPSIS Adapters to support the delete operation for Semesters.
The interface implementation is D2L.IM.IPSIS.OrgUnits.Semesters.Handlers.IDeleteSemesterHandler
The following configuration lists provide a starting point for any IPSIS implementation:
IPSIS, Template - Semester
- DeleteSemesterIMHandler (Sort Order = 10)
DeleteSemesterIMHandler
Implementation
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.DeleteSemesterIMHandler
Expected behavior
If there is anything dependent on the Semester (IM Hierarchy children) this must fail. The handler performs the following tasks:
- The handler performs a soft-delete of the Semester from the IPSIS tables.
- Deletes any IM Hierarchy parent entries that reference this Semester.
- Processing continues to the next configured handler.
Error behavior
If there is a problem during processing, an exception is thrown, along with as much detailed information as possible.
Configuration note
This handler should be configured as the last Delete handler.
DeleteSemesterLMSHandler
The DeleteSemesterLMSHandler deletes the Semester from the LMS if it has no children in the org structure.
Implementation
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.DeleteSemesterLMSHandler
Expected behavior
The handler performs the following tasks:
If the semester has no LMS children, the handler deletes the Semester (automatically creating an audit entry) and deletes the IM Mapping for the Semester.
Note: The semester is available in the recycle bin in the LMS.
Error behavior
If there is a problem during processing, an exception is thrown, along with as much detailed information as possible.
Configuration note
This handler should be configured as before the IM Delete handler.
DeleteSemesterCascadeDeleteCourseOfferingHandler
The DeleteSemesterCascadeDeleteCourseOfferingHandler is used to cascade the delete to any Course Offering children that still exist.
Implementation
D2L.IM.IPSIS.Default.OrgUnits.Semesters.Handlers.DeleteSemesterCascadeDeleteCourseOfferingHandler
Expected behavior
The handler performs the following tasks:
- For each remaining Course Offering referencing this Semester in the IM Hierarchies Tables, the handlers configured for IDeleteCourseOffering delete the Course Offerings.
- Processing continues to the next handler (Return True).
Error behavior
If there is a problem during processing, an exception is thrown, along with as much detailed information as possible.
Configuration note
This must occur before either the LMS or IM Table deletes (examples: DeleteSemesterLMSHandler, DeleteSemesterIMHandler).