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

import edu.ksu.canvas.model.Enrollment;
import edu.ksu.canvas.requestOptions.GetEnrollmentOptions;

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

public interface EnrollmentReader extends CanvasReader {
    /**
     * Retrieve a user's enrollments. Object ID in the options class must be a user ID.
     * @param options API options available to this call
     * @return List of the user's enrollments
     * @throws IOException When there is an error communicating with Canvas
     */
     List getUserEnrollments(GetEnrollmentOptions options) throws IOException;

     /**
      * Retrieve enrollments in a given section. Object ID in the options class must be a section ID.
      * @param options API options available to this call
      * @return List of enrollments in a section
      * @throws IOException When there is an error communicating with Canvas
      */
     List getSectionEnrollments(GetEnrollmentOptions options) throws IOException;

     /**
      * Retrieve enrollments in a given course. Object ID in the options class must be a course ID.
      * @param options API options available to this call
      * @return List of enrollments in a course
      * @throws IOException When there is an error communicating with Canvas
      */
     List getCourseEnrollments(GetEnrollmentOptions options) throws IOException;

}