edu.ksu.canvas.model.assignment

Class QuizSubmissionResponse

java.lang.Object

edu.ksu.canvas.model.assignment.QuizSubmissionResponse

public class QuizSubmissionResponse
extends Object

Object to capture the response of Quiz Submission API calls. When you ask for users and/or quiz information to be included in the response (via GetQuizSubmissionsOptions), Canvas returns them as top level lists along with the QuizSubmission objects. This is unlike other API calls with optional includes which typically return the requested includes as nested objects instead of the top level list. The users are stored in a map by user ID to make them easy to look up if you need the user object while doing something with the submissions.

Constructor Summary

Constructors

Constructor and Description
QuizSubmissionResponse(List<QuizSubmission> quizSubmissions, List<User> users, List<Quiz> quizzes)

Method Summary

Modifier and Type	Method and Description
Optional<Quiz>	getQuiz(int quizId) Find a quiz associated with the queried quiz submissions (if quizzes were requested via GetQuizSubmissionsOptions)
List<QuizSubmission>	getQuizSubmissions() Get the requested list of queried QuizSubmission objects
Map<Integer,Quiz>	getQuizzes() Get a quiz ID to Quiz map of quizzes returned by the quiz submission query.
Optional<User>	getUser(long userId) Find a user associated with the queried quiz submissions (if users were requested via GetQuizSubmissionsOptions)
Map<Long,User>	getUsers() Get a userID to User map of all users associated with the queried quiz submissions if users were requested via GetQuizSubmissionsOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QuizSubmissionResponse

public QuizSubmissionResponse(List<QuizSubmission> quizSubmissions,
                              List<User> users,
                              List<Quiz> quizzes)

Method Detail

getQuizSubmissions

public List<QuizSubmission> getQuizSubmissions()

Get the requested list of queried QuizSubmission objects

Returns:

The requested quiz submissions

getUsers

public Map<Long,User> getUsers()

Get a userID to User map of all users associated with the queried quiz submissions if users were requested via GetQuizSubmissionsOptions

Returns:

User map

getUser

public Optional<User> getUser(long userId)

Find a user associated with the queried quiz submissions (if users were requested via GetQuizSubmissionsOptions)

Parameters:

userId - Canvas user ID

Returns:

Canvas user record if found

getQuizzes

public Map<Integer,Quiz> getQuizzes()

Get a quiz ID to Quiz map of quizzes returned by the quiz submission query. Only populated if quizzes were requested in the original query via GetQuizSubmissionsOptions. While this comes from Canvas as a list, I THINK there should only ever be one element given that quiz submissions are queried by specific quiz ID.

Returns:

Quiz associated with these submissions

getQuiz

public Optional<Quiz> getQuiz(int quizId)

Find a quiz associated with the queried quiz submissions (if quizzes were requested via GetQuizSubmissionsOptions)

Parameters:

quizId - Canvas ID of the quiz

Returns:

The requested Quiz object if found