edu.ksu.canvas.impl

Class QuizImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<Quiz,QuizReader,QuizWriter>

edu.ksu.canvas.impl.QuizImpl

All Implemented Interfaces:

CanvasReader<Quiz,QuizReader>, CanvasWriter<Quiz,QuizWriter>, QuizReader, QuizWriter

public class QuizImpl
extends BaseImpl<Quiz,QuizReader,QuizWriter>
implements QuizReader, QuizWriter

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
QuizImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls)

Method Summary

Modifier and Type	Method and Description
List<Quiz>	getQuizzesInCourse(String courseId) Retrieve a list of quizzes from Canvas by its course Canvas ID number
Optional<Quiz>	getSingleQuiz(String courseId, String quizId) Retrieve a specific quiz from Canvas by its course and quiz Canvas ID numbers
protected Type	listType()
protected Class<Quiz>	objectType()
Optional<Quiz>	updateQuiz(Quiz quiz, String courseId)

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

QuizImpl

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

Method Detail

getSingleQuiz

public Optional<Quiz> getSingleQuiz(String courseId,
                                    String quizId)
                             throws IOException

Description copied from interface: QuizReader

Retrieve a specific quiz from Canvas by its course and quiz Canvas ID numbers

Specified by:

getSingleQuiz in interface QuizReader

Parameters:

courseId - The Canvas ID of the course

quizId - The Canvas ID of the quiz

Returns:

The assignment returned by Canvas or an empty Optional

Throws:

IOException - When there is an error communicating with Canvas

getQuizzesInCourse

public List<Quiz> getQuizzesInCourse(String courseId)
                              throws IOException

Description copied from interface: QuizReader

Retrieve a list of quizzes from Canvas by its course Canvas ID number

Specified by:

getQuizzesInCourse in interface QuizReader

Parameters:

courseId - The Canvas ID of the course

Returns:

List of quizzes in the course with the course ID

Throws:

IOException - When there is an error communicating with Canvas

updateQuiz

public Optional<Quiz> updateQuiz(Quiz quiz,
                                 String courseId)
                          throws IOException

Specified by:

updateQuiz in interface QuizWriter

Parameters:

quiz - The quiz to update

courseId - The course ID in which the quiz lives

Returns:

The updated Quiz object

Throws:

IOException - When there is an error communicating with Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<Quiz,QuizReader,QuizWriter>

objectType

protected Class<Quiz> objectType()

Specified by:

objectType in class BaseImpl<Quiz,QuizReader,QuizWriter>