edu.ksu.canvas.interfaces

Interface QuizSubmissionWriter

All Superinterfaces:

CanvasWriter<QuizSubmission,QuizSubmissionWriter>

All Known Implementing Classes:

QuizSubmissionImpl

public interface QuizSubmissionWriter
extends CanvasWriter<QuizSubmission,QuizSubmissionWriter>

Method Summary

Modifier and Type	Method and Description
Optional<QuizSubmission>	completeQuizSubmission(CompleteQuizSubmissionOptions options) Finish a quiz submission.
Optional<QuizSubmission>	startQuizSubmission(StartQuizSubmissionOptions options) Opens a quiz submission which can be used to answer questions and submit answers

Methods inherited from interface edu.ksu.canvas.interfaces.CanvasWriter

writeAsCanvasUser, writeAsSisUser

Method Detail

startQuizSubmission

Optional<QuizSubmission> startQuizSubmission(StartQuizSubmissionOptions options)
                                      throws IOException

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

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

Optional<QuizSubmission> completeQuizSubmission(CompleteQuizSubmissionOptions options)
                                         throws IOException

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

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