edu.ksu.canvas.impl

Class QuizSubmissionImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<QuizSubmission,QuizSubmissionReader,QuizSubmissionWriter>

edu.ksu.canvas.impl.QuizSubmissionImpl

All Implemented Interfaces:

CanvasReader<QuizSubmission,QuizSubmissionReader>, CanvasWriter<QuizSubmission,QuizSubmissionWriter>, QuizSubmissionReader, QuizSubmissionWriter

public class QuizSubmissionImpl
extends BaseImpl<QuizSubmission,QuizSubmissionReader,QuizSubmissionWriter>
implements QuizSubmissionReader, QuizSubmissionWriter

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
QuizSubmissionImpl(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<QuizSubmission>	completeQuizSubmission(CompleteQuizSubmissionOptions options) Finish a quiz submission.
QuizSubmissionResponse	getQuizSubmissions(GetQuizSubmissionsOptions options) Retrieve a list of quiz submissions with user and quiz information optionally included
List<QuizSubmission>	getQuizSubmissions(String courseId, String quizId) Retrieve a list of quiz submissions from Canvas by its course and quiz Canvas ID numbers
protected Type	listType()
protected Class<QuizSubmission>	objectType()
Optional<QuizSubmission>	startQuizSubmission(StartQuizSubmissionOptions options) Opens a quiz submission which can be used to answer questions and submit answers

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

QuizSubmissionImpl

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

Method Detail

getQuizSubmissions

public List<QuizSubmission> getQuizSubmissions(String courseId,
                                               String quizId)
                                        throws IOException

Description copied from interface: QuizSubmissionReader

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

Specified by:

getQuizSubmissions in interface QuizSubmissionReader

Parameters:

courseId - The Canvas ID of the course

quizId - The Canvas ID of the quiz

Returns:

List of quiz submissions in the course with the course ID

Throws:

IOException - When there is an error communicating with Canvas

getQuizSubmissions

public QuizSubmissionResponse getQuizSubmissions(GetQuizSubmissionsOptions options)
                                          throws IOException

Description copied from interface: QuizSubmissionReader

Retrieve a list of quiz submissions with user and quiz information optionally included

Specified by:

getQuizSubmissions in interface QuizSubmissionReader

Parameters:

options - Options class containing required and optional parameters for this API call

Returns:

List of quiz submissions in the course with the course ID

Throws:

IOException - When there is an error communicating with Canvas

startQuizSubmission

public Optional<QuizSubmission> startQuizSubmission(StartQuizSubmissionOptions options)
                                             throws IOException

Description copied from interface: QuizSubmissionWriter

Opens a quiz submission which can be used to answer questions and submit answers

Specified by:

startQuizSubmission in interface QuizSubmissionWriter

Parameters:

options - API options to be used to open a submission

Returns:

The quiz submission object created by Canvas

Throws:

IOException - If there is an error talking to Canvas

completeQuizSubmission

public Optional<QuizSubmission> completeQuizSubmission(CompleteQuizSubmissionOptions options)
                                                throws IOException

Description copied from interface: QuizSubmissionWriter

Finish a quiz submission. This turns it in and grades it. After this call, no further modifications are allowed.

Specified by:

completeQuizSubmission in interface QuizSubmissionWriter

Parameters:

options - API options to be used in closing the submission

Returns:

The quiz submission object returned by Canvas

Throws:

IOException - If there is an error talking to Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<QuizSubmission,QuizSubmissionReader,QuizSubmissionWriter>

objectType

protected Class<QuizSubmission> objectType()

Specified by:

objectType in class BaseImpl<QuizSubmission,QuizSubmissionReader,QuizSubmissionWriter>