edu.ksu.canvas.requestOptions.ListModulesOptions 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

The newest version!

package edu.ksu.canvas.requestOptions;

import java.util.List;

/**
 * Options for listing the modules in a course.
 *
 * @see List modules
 */
public class ListModulesOptions extends BaseOptions {

    public enum Include {
        ITEMS,
        CONTENT_DETAILS
    }

    private Long courseId;

    public ListModulesOptions(Long courseId) {
        this.courseId = courseId;
    }

    public Long getCourseId() {
        return courseId;
    }

    public ListModulesOptions includes(List includes) {
        addEnumList("include[]", includes);
        return this;
    }

    public ListModulesOptions searchTerm(String searchTerm) {
        addSingleItem("search_term", searchTerm);
        return this;
    }

    public ListModulesOptions studentId(String studentId) {
        addSingleItem("student_id", studentId);
        return this;
    }

}