edu.ksu.canvas.interfaces.CourseSettingsWriter Maven / Gradle / Ivy
package edu.ksu.canvas.interfaces;
import edu.ksu.canvas.model.CourseSettings;
import java.io.IOException;
import java.util.Optional;
public interface CourseSettingsWriter extends CanvasWriter {
/**
* Push modified course settings to Canvas.
*
* Only fields with the @CanvasField annotation can be changed.
* @param courseId Canvas ID (or sis_course_id:XXXX) of the course
* @param settings New settings to push to Canvas
* @return The updated course settings
* @throws IOException When there is an error communicating with Canvas
*/
Optional updateCourseSettings(String courseId, CourseSettings settings) throws IOException;
}