edu.ksu.canvas.impl

Class CourseSettingsImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<CourseSettings,CourseSettingsReader,CourseSettingsWriter>

edu.ksu.canvas.impl.CourseSettingsImpl

All Implemented Interfaces:

CanvasReader<CourseSettings,CourseSettingsReader>, CanvasWriter<CourseSettings,CourseSettingsWriter>, CourseSettingsReader, CourseSettingsWriter

public class CourseSettingsImpl
extends BaseImpl<CourseSettings,CourseSettingsReader,CourseSettingsWriter>
implements CourseSettingsReader, CourseSettingsWriter

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
CourseSettingsImpl(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<CourseSettings>	getCourseSettings(String courseId) Returns course settings from Canvas
protected Type	listType()
protected Class<CourseSettings>	objectType()
Optional<CourseSettings>	updateCourseSettings(String courseId, CourseSettings settings) Push modified course settings to Canvas.

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

CourseSettingsImpl

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

Method Detail

getCourseSettings

public Optional<CourseSettings> getCourseSettings(String courseId)
                                           throws IOException

Description copied from interface: CourseSettingsReader

Returns course settings from Canvas

See Get course settings in the Canvas docs for details.

Specified by:

getCourseSettings in interface CourseSettingsReader

Parameters:

courseId - The Canvas ID of the course or sis_course_id:SISID

Returns:

The course settings from Canvas

Throws:

IOException - When there is an error communicating with Canvas

updateCourseSettings

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

Description copied from interface: CourseSettingsWriter

Push modified course settings to Canvas.

Only fields with the @CanvasField annotation can be changed.

Specified by:

updateCourseSettings in interface CourseSettingsWriter

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

listType

protected Type listType()

Specified by:

listType in class BaseImpl<CourseSettings,CourseSettingsReader,CourseSettingsWriter>

objectType

protected Class<CourseSettings> objectType()

Specified by:

objectType in class BaseImpl<CourseSettings,CourseSettingsReader,CourseSettingsWriter>