edu.ksu.canvas.impl

Class QuizQuestionImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<QuizQuestion,QuizQuestionReader,QuizQuestionWriter>

edu.ksu.canvas.impl.QuizQuestionImpl

All Implemented Interfaces:

CanvasReader<QuizQuestion,QuizQuestionReader>, CanvasWriter<QuizQuestion,QuizQuestionWriter>, QuizQuestionReader, QuizQuestionWriter

public class QuizQuestionImpl
extends BaseImpl<QuizQuestion,QuizQuestionReader,QuizQuestionWriter>
implements QuizQuestionReader, QuizQuestionWriter

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

Method Summary

Modifier and Type	Method and Description
boolean	deleteQuizQuestion(String courseId, Integer quizId, Integer questionId) Delete a quiz question
List<QuizQuestion>	getQuizQuestions(GetQuizQuestionsOptions options) Retrieve a list of quiz questions from Canvas by its course and quiz Canvas ID numbers
protected Type	listType()
protected Class<QuizQuestion>	objectType()

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

QuizQuestionImpl

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

Method Detail

getQuizQuestions

public List<QuizQuestion> getQuizQuestions(GetQuizQuestionsOptions options)
                                    throws IOException

Description copied from interface: QuizQuestionReader

Retrieve a list of quiz questions from Canvas by its course and quiz Canvas ID numbers

Specified by:

getQuizQuestions in interface QuizQuestionReader

Parameters:

options - The API options associated with this request

Returns:

List of quizzes questions in the course with the course ID

Throws:

IOException - When there is an error communicating with Canvas

deleteQuizQuestion

public boolean deleteQuizQuestion(String courseId,
                                  Integer quizId,
                                  Integer questionId)
                           throws IOException

Description copied from interface: QuizQuestionWriter

Delete a quiz question

Specified by:

deleteQuizQuestion in interface QuizQuestionWriter

Parameters:

courseId - Course ID containing the quiz to modify

quizId - Quiz ID with question to delete

questionId - Question ID of question to delete

Returns:

true if deletion was successful (API returned HTTP 204), false otherwise

Throws:

IOException - if there is an error communicating with Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<QuizQuestion,QuizQuestionReader,QuizQuestionWriter>

objectType

protected Class<QuizQuestion> objectType()

Specified by:

objectType in class BaseImpl<QuizQuestion,QuizQuestionReader,QuizQuestionWriter>