edu.ksu.canvas.impl

Class CourseImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<Course,CourseReader,CourseWriter>

edu.ksu.canvas.impl.CourseImpl

All Implemented Interfaces:

CanvasReader<Course,CourseReader>, CanvasWriter<Course,CourseWriter>, CourseReader, CourseWriter

public class CourseImpl
extends BaseImpl<Course,CourseReader,CourseWriter>
implements CourseReader, CourseWriter

Field Summary

Fields inherited from class edu.ksu.canvas.impl.BaseImpl

apiVersion, canvasBaseUrl, canvasMessenger, masqueradeAs, masqueradeType, oauthToken, paginationPageSize, responseCallback, responseParser, serializeNulls

Constructor Summary

Constructors

Constructor and Description
CourseImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls)

Method Summary

Modifier and Type	Method and Description
Optional<Progress>	batchUpdateCourseState(String accountId, Course.CourseEvent event, String... courseIds) Change the workflow state of multiple courses at once This operation happens asynchronously and returns a Progress object to monitor its execution.
Optional<Course>	createCourse(String accountId, Course course) Create a new course in Canvas
Boolean	deleteCourse(DeleteCourseOptions options) Delete or conclude a course in Canvas.
Boolean	deleteCourse(String courseId)
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
protected Type	listType()
List<Course>	listUserCourses(ListUserCoursesOptions options) Returns the list of active courses for the a user
protected Class<Course>	objectType()
Optional<Course>	updateCourse(Course course) Update a course in Canvas
Optional<Course>	updateCourse(String id, Course course) Update a course in Canvas
Optional<Deposit>	uploadFile(String courseId, UploadOptions uploadOptions) Start a file upload to a course.

Methods inherited from class edu.ksu.canvas.impl.BaseImpl

buildCanvasUrl, encode, getFromCanvas, getListFromCanvas, parseListOfResponses, readAsCanvasUser, readAsSisUser, withCallback, writeAsCanvasUser, writeAsSisUser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

readAsCanvasUser, readAsSisUser, withCallback

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

writeAsCanvasUser, writeAsSisUser

Constructor Detail

CourseImpl

public CourseImpl(String canvasBaseUrl,
                  Integer apiVersion,
                  OauthToken oauthToken,
                  RestClient restClient,
                  int connectTimeout,
                  int readTimeout,
                  Integer paginationPageSize,
                  Boolean serializeNulls)

Method Detail

listCurrentUserCourses

public List<Course> listCurrentUserCourses(ListCurrentUserCoursesOptions options)
                                    throws IOException

Description copied from interface: CourseReader

Returns the list of active courses for the current user

Specified by:

listCurrentUserCourses in interface CourseReader

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

public List<Course> listUserCourses(ListUserCoursesOptions options)
                             throws IOException

Description copied from interface: CourseReader

Returns the list of active courses for the a user

Specified by:

listUserCourses in interface CourseReader

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

public Optional<Course> getSingleCourse(GetSingleCourseOptions options)
                                 throws IOException

Description copied from interface: CourseReader

Retrieve a specific course from Canvas by its Canvas ID number

Specified by:

getSingleCourse in interface CourseReader

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

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

Description copied from interface: CourseReader

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

Specified by:

getSingleCourse in interface CourseReader

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

createCourse

public Optional<Course> createCourse(String accountId,
                                     Course course)
                              throws IOException

Description copied from interface: CourseWriter

Create a new course in Canvas

Specified by:

createCourse in interface CourseWriter

Parameters:

accountId - the account ID of the account under which to place this course

course - A course object containing the information needed to create a course in Canvas

Returns:

The newly created course

Throws:

IOException - When there is an error communicating with Canvas

updateCourse

public Optional<Course> updateCourse(Course course)
                              throws IOException

Description copied from interface: CourseWriter

Update a course in Canvas

Specified by:

updateCourse in interface CourseWriter

Parameters:

course - A course object containing the information needed to update a course in Canvas

Returns:

The newly updated course

Throws:

IOException - When there is an error communicating with Canvas

updateCourse

public Optional<Course> updateCourse(String id,
                                     Course course)
                              throws IOException

Description copied from interface: CourseWriter

Update a course in Canvas

Specified by:

updateCourse in interface CourseWriter

Parameters:

id - The ID of the course to update, this is useful when you want to update a course by it's SIS ID, for example with "sis_course_id:id-123"

course - A course object containing the information needed to update a course in Canvas

Returns:

The newly updated course

Throws:

IOException - When there is an error communicating with Canvas

deleteCourse

public Boolean deleteCourse(String courseId)
                     throws IOException

Specified by:

deleteCourse in interface CourseWriter

Parameters:

courseId - The ID of the course you wish to delete

Returns:

true if the course was deleted

Throws:

IOException - When there is an error communicating with Canvas

deleteCourse

public Boolean deleteCourse(DeleteCourseOptions options)
                     throws IOException

Description copied from interface: CourseWriter

Delete or conclude a course in Canvas.

Specified by:

deleteCourse in interface CourseWriter

Parameters:

options - (specifying the ID and whether to delete or conclude the course)

Returns:

true if the operation was successful

Throws:

IOException - When there is an error communicating with Canvas

listActiveCoursesInAccount

public List<Course> listActiveCoursesInAccount(ListActiveCoursesInAccountOptions options)
                                        throws IOException

Description copied from interface: CourseReader

Retrieve a list of all courses on a given account

Specified by:

listActiveCoursesInAccount in interface CourseReader

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

uploadFile

public Optional<Deposit> uploadFile(String courseId,
                                    UploadOptions uploadOptions)
                             throws IOException

Description copied from interface: CourseWriter

Start a file upload to a course.

Specified by:

uploadFile in interface CourseWriter

Parameters:

courseId - The id of the course where the file upload will be done

uploadOptions - Upload file configuration

Returns:

Deposit (This is part of the file upload workflow)

Throws:

IOException - When there is an error communicating with Canvas

batchUpdateCourseState

public Optional<Progress> batchUpdateCourseState(String accountId,
                                                 Course.CourseEvent event,
                                                 String... courseIds)
                                          throws IOException

Description copied from interface: CourseWriter

Change the workflow state of multiple courses at once This operation happens asynchronously and returns a Progress object to monitor its execution. Valid events are: offer, conclude, delete and undelete. It is NOT possible to claim a course using this method. See: https://canvas.instructure.com/doc/api/courses.html#method.courses.batch_update

Specified by:

batchUpdateCourseState in interface CourseWriter

Parameters:

accountId - The ID of the account in which to perform this bulk operation

event - The course event type to push

courseIds - A list of course IDs to perform this operation on

Returns:

Progress object to monitor the state of the batch operation

Throws:

IOException - When there is an error communicating with Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<Course,CourseReader,CourseWriter>

objectType

protected Class<Course> objectType()

Specified by:

objectType in class BaseImpl<Course,CourseReader,CourseWriter>