edu.ksu.canvas.requestOptions.GetQuizQuestionsOptions Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of canvas-api Show documentation

A native Java library to talk to the Canvas REST API

There is a newer version: 2.0.0

package edu.ksu.canvas.requestOptions;

public class GetQuizQuestionsOptions extends BaseOptions {

    private String courseId;
    private Integer quizId;

    public GetQuizQuestionsOptions(String courseId, Integer quizId) {
        this.courseId = courseId;
        this.quizId = quizId;
    }

    public String getCourseId() {
        return courseId;
    }

    public Integer getQuizId() {
        return quizId;
    }

    /**
     * If specified, this request will return the questions that were presented for the given submission.
     * Useful if the quiz was modified after the submission was created.
     * NOTE: If you specify this parameter, you MUST also specify the quizSubmissionAttempt.
     * @param submissionId Quiz Submission ID to get questions for
     * @return This object to allow adding more options
     */
    public GetQuizQuestionsOptions quizSubmissionId(Integer submissionId) {
        addSingleItem("quiz_submission_id", submissionId.toString());
        return this;
    }

    /**
     * The attempt of the submission you want the questions for
     * @param submissionAttempt The ID of the submission attempt
     * @return This object to allow adding more options
     */
    public GetQuizQuestionsOptions quizSubmissionAttempt(Integer submissionAttempt) {
        addSingleItem("quiz_submission_attempt", submissionAttempt.toString());
        return this;
    }

}