Description

This class is introduced in v3.14.

When:

• there are Course Connections and Session Connections that were created as a result of registering to a Study Offering that is linked to a Course Offering,
  
  AND,
   
• the related Study Registration is updated to have a status that defines Withdrawn = TRUE,

then, this class will withdraw the student from the Course Connections and Session Connections that are associated with that Course Offering. Both the Course Connections and Session Connections will have their status updated to ‘Withdrawn’.

By default, the Study Registration status that will trigger this is ‘Cancelled’, but this can be configured. See the Study Registration Status Custom Metadata Type.

Use case

A Study Offering can be linked to a Course Offering, such that when students register to it, they will be enrolled to Course Connections and Session Connections.

• See that TDTM here.

This TDTM, on the other hand, caters for situations when the student wishes to withdraw from them.

By having the student's Study Registration updated to Status = Cancelled (by default), the student will be withdrawn from the Course Connection and Session Connection that is associated with that Course Offering.

For more details, see: How Continuing Education works.

Side note:

If the RIO Education custom setting has “Withdrawn CCs delete SCs” = TRUE, then, withdrawing a Course Connection will delete the related Session Connections, if there are no attendances yet.

If there already are attendances taken, then, the Session Connection will not be deleted, but withdrawn instead.