edu.ksu.canvas.interfaces

Interface CourseSettingsWriter

All Superinterfaces:

CanvasWriter<CourseSettings,CourseSettingsWriter>

All Known Implementing Classes:

CourseSettingsImpl

public interface CourseSettingsWriter
extends CanvasWriter<CourseSettings,CourseSettingsWriter>

Method Summary

Modifier and Type	Method and Description
Optional<CourseSettings>	updateCourseSettings(String courseId, CourseSettings settings) Push modified course settings to Canvas.

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

writeAsCanvasUser, writeAsSisUser

Method Detail

updateCourseSettings

Optional<CourseSettings> updateCourseSettings(String courseId,
                                              CourseSettings settings)
                                       throws IOException

Push modified course settings to Canvas.

Only fields with the @CanvasField annotation can be changed.

Parameters:

courseId - Canvas ID (or sis_course_id:XXXX) of the course

settings - New settings to push to Canvas

Returns:

The updated course settings

Throws:

IOException - When there is an error communicating with Canvas