edu.ksu.canvas.interfaces

Interface CourseWriter

All Superinterfaces:

CanvasWriter<Course,CourseWriter>

All Known Implementing Classes:

CourseImpl

public interface CourseWriter
extends CanvasWriter<Course,CourseWriter>

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>	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 options) Start a file upload to a course.

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

writeAsCanvasUser, writeAsSisUser

Method Detail

createCourse

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

Create a new course in Canvas

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

Optional<Course> updateCourse(Course course)
                       throws IOException

Update a course in Canvas

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

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

Update a course in Canvas

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

Boolean deleteCourse(String courseId)
              throws IOException

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

Boolean deleteCourse(DeleteCourseOptions options)
              throws IOException

Delete or conclude a course in Canvas.

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

uploadFile

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

Start a file upload to a course.

Parameters:

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

options - Upload file configuration

Returns:

Deposit (This is part of the file upload workflow)

Throws:

IOException - When there is an error communicating with Canvas

batchUpdateCourseState

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

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

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