edu.ksu.canvas.interfaces

Interface EnrollmentReader

All Superinterfaces:

CanvasReader<Enrollment,EnrollmentReader>

All Known Implementing Classes:

EnrollmentImpl

public interface EnrollmentReader
extends CanvasReader<Enrollment,EnrollmentReader>

Method Summary

Modifier and Type	Method and Description
List<Enrollment>	getCourseEnrollments(GetEnrollmentOptions options) Retrieve enrollments in a given course.
List<Enrollment>	getSectionEnrollments(GetEnrollmentOptions options) Retrieve enrollments in a given section.
List<Enrollment>	getUserEnrollments(GetEnrollmentOptions options) Retrieve a user's enrollments.

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

getUserEnrollments

List<Enrollment> getUserEnrollments(GetEnrollmentOptions options)
                             throws IOException

Retrieve a user's enrollments. Object ID in the options class must be a user ID.

Parameters:

options - API options available to this call

Returns:

List of the user's enrollments

Throws:

IOException - When there is an error communicating with Canvas

getSectionEnrollments

List<Enrollment> getSectionEnrollments(GetEnrollmentOptions options)
                                throws IOException

Retrieve enrollments in a given section. Object ID in the options class must be a section ID.

Parameters:

options - API options available to this call

Returns:

List of enrollments in a section

Throws:

IOException - When there is an error communicating with Canvas

getCourseEnrollments

List<Enrollment> getCourseEnrollments(GetEnrollmentOptions options)
                               throws IOException

Retrieve enrollments in a given course. Object ID in the options class must be a course ID.

Parameters:

options - API options available to this call

Returns:

List of enrollments in a course

Throws:

IOException - When there is an error communicating with Canvas