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

Go to download

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;

import com.google.common.collect.ImmutableList;

import java.util.ArrayList;
import java.util.List;

public class GetQuizSubmissionsOptions extends BaseOptions {
    private String courseId;
    private String quizId;

    public enum Include {
        // The canvas API gives a 3rd option here with a value of "submissions" but does not document what is
        // returned so I am not including it as an option until we can determine exactly what it is.
        USER, QUIZ;

        public String toString() {
            return name().toLowerCase();
        }
    }

    /**
     * Optionally include more information with the returned Quiz Submission objects.
     * @param includes List of optional includes
     * @return This object to allow adding more options
     */
    public GetQuizSubmissionsOptions includes(final List includes) {
        addEnumList("include[]", includes);
        return this;
    }

    public GetQuizSubmissionsOptions(final String courseId, final String quizId, final Include... includes) {
        this.courseId = courseId;
        this.quizId = quizId;
        if (includes.length > 0) {
            includes(ImmutableList.copyOf(includes));
        }
    }

    public String getCourseId() {
        return courseId;
    }

    public void setCourseId(final String courseId) {
        this.courseId = courseId;
    }

    public String getQuizId() {
        return quizId;
    }

    public void setQuizId(final String quizId) {
        this.quizId = quizId;
    }
}