edu.ksu.canvas.interfaces

Interface EnrollmentWriter

All Superinterfaces:

CanvasWriter<Enrollment,EnrollmentWriter>

All Known Implementing Classes:

EnrollmentImpl

public interface EnrollmentWriter
extends CanvasWriter<Enrollment,EnrollmentWriter>

Method Summary

Modifier and Type	Method and Description
Optional<Enrollment>	dropUser(String courseId, String enrollmentId) Drop a user enrolled in a course using the Unenrollment option of DELETE.
Optional<Enrollment>	dropUser(String courseId, String enrollmentId, UnEnrollOptions unEnrollOption) Drop a user enrolled in a course passing the UnEnrollOptions string in the task param.
Optional<Enrollment>	enrollUser(Enrollment enrollment) Deprecated. Use the enrollUserInCourse or enrollUserInSection methods instead.
Optional<Enrollment>	enrollUserInCourse(Enrollment enrollment) Enrolls a user in a course
Optional<Enrollment>	enrollUserInSection(Enrollment enrollment) Enrolls a user in a section.

Methods inherited from interface edu.ksu.canvas.interfaces.CanvasWriter

writeAsCanvasUser, writeAsSisUser

Method Detail

enrollUser

@Deprecated
Optional<Enrollment> enrollUser(Enrollment enrollment)
                                     throws IllegalArgumentException,
                                            IOException

Deprecated. Use the enrollUserInCourse or enrollUserInSection methods instead.

Enroll a user in a course.

Parameters:

enrollment - partially populated Enrollment object

Returns:

optional enrollment

Throws:

IllegalArgumentException - when the enrollment courseID is not set

IOException - if there is an error communicating with Canvas

enrollUserInCourse

Optional<Enrollment> enrollUserInCourse(Enrollment enrollment)
                                 throws IllegalArgumentException,
                                        IOException

Enrolls a user in a course

Parameters:

enrollment - partially populated Enrollment object

Returns:

optional enrollment

Throws:

IllegalArgumentException - when the enrollment courseID is not set

IOException - if there is an error communicating with Canvas

enrollUserInSection

Optional<Enrollment> enrollUserInSection(Enrollment enrollment)
                                  throws IllegalArgumentException,
                                         IOException

Enrolls a user in a section.

Parameters:

enrollment - partially populated Enrollment object

Returns:

optional enrollment

Throws:

IllegalArgumentException - when the enrollment courseSectionId is not set

IOException - if there is an error communicating with Canvas

dropUser

Optional<Enrollment> dropUser(String courseId,
                              String enrollmentId,
                              UnEnrollOptions unEnrollOption)
                       throws IOException

Drop a user enrolled in a course passing the UnEnrollOptions string in the task param.

Parameters:

courseId - - Canvas course identifier

enrollmentId - - Canvas enrollment identifier

unEnrollOption - - UnEnrollOption enum value of delete, conclude, inactivate or deactivate

Returns:

Populated Enrollment Dropped when successful

Throws:

IOException - if there is an error communicating with Canvas

dropUser

Optional<Enrollment> dropUser(String courseId,
                              String enrollmentId)
                       throws IOException

Drop a user enrolled in a course using the Unenrollment option of DELETE.

Parameters:

courseId - - Canvas course identifier

enrollmentId - enrollmentId - Canvas enrollment identifier

Returns:

Populated Enrollment Dropped when successful

Throws:

IOException - if there is an error communicating with Canvas