edu.ksu.canvas.interfaces.ModuleReader 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

The newest version!

package edu.ksu.canvas.interfaces;

import edu.ksu.canvas.model.Module;
import edu.ksu.canvas.requestOptions.ListModulesOptions;

import java.io.IOException;
import java.util.List;

public interface ModuleReader extends CanvasReader {
    /**
     * Retrieve the list of modules in a course.
     *
     * @param options The object holding options for this API call
     * @return List of the course's modules
     * @throws IOException When there is an error communicating with Canvas
     */
    public List getModulesInCourse(ListModulesOptions options) throws IOException;

}