edu.ksu.canvas.interfaces

Interface CourseReader

All Superinterfaces:

CanvasReader<Course,CourseReader>

All Known Implementing Classes:

CourseImpl

public interface CourseReader
extends CanvasReader<Course,CourseReader>

Methods to read information from and about courses

Method Summary

Modifier and Type	Method and Description
Optional<Course>	getSingleCourse(GetSingleCourseOptions options) Retrieve a specific course from Canvas by its Canvas ID number
Optional<Course>	getSingleCourse(String accountId, GetSingleCourseOptions options) Retrieve a specific course from a Canvas account by its Canvas ID number
List<Course>	listActiveCoursesInAccount(ListActiveCoursesInAccountOptions options) Retrieve a list of all courses on a given account
List<Course>	listCurrentUserCourses(ListCurrentUserCoursesOptions options) Returns the list of active courses for the current user
List<Course>	listUserCourses(ListUserCoursesOptions options) Returns the list of active courses for the a user

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

listCurrentUserCourses

List<Course> listCurrentUserCourses(ListCurrentUserCoursesOptions options)
                             throws IOException

Returns the list of active courses for the current user

Parameters:

options - The object holding options for this API call

Returns:

List of courses for the user matching any optional criteria

Throws:

IOException - When there is an error communicating with Canvas

listUserCourses

List<Course> listUserCourses(ListUserCoursesOptions options)
                      throws IOException

Returns the list of active courses for the a user

Parameters:

options - The object holding options for this API call

Returns:

List of courses for the user matching any optional criteria

Throws:

IOException - When there is an error communicating with Canvas

getSingleCourse

Optional<Course> getSingleCourse(GetSingleCourseOptions options)
                          throws IOException

Retrieve a specific course from Canvas by its Canvas ID number

Parameters:

options - The object holding options for this API call

Returns:

The course returned by Canvas or an empty Optional

Throws:

IOException - When there is an error communicating with Canvas

getSingleCourse

Optional<Course> getSingleCourse(String accountId,
                                 GetSingleCourseOptions options)
                          throws IOException

Retrieve a specific course from a Canvas account by its Canvas ID number

Parameters:

accountId - The account to look for the course in.

options - The object holding options for this API call

Returns:

The course returned by Canvas or an empty Optional

Throws:

IOException - When there is an error communicating with Canvas

listActiveCoursesInAccount

List<Course> listActiveCoursesInAccount(ListActiveCoursesInAccountOptions options)
                                 throws IOException

Retrieve a list of all courses on a given account

Parameters:

options - AccountCourseListOptions object representing params to this API call

Returns:

List of courses in the account

Throws:

IOException - When there is an error communicating with Canvas