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

import java.io.IOException;
import java.util.Optional;

public interface EnrollmentWriter extends CanvasWriter {

     /**
      * Enroll a user in a course.
      *
      * @deprecated Use the enrollUserInCourse or enrollUserInSection methods instead.
      *
      * @param  enrollment partially populated Enrollment object
      * @return optional enrollment
      * @throws IllegalArgumentException when the enrollment courseID is not set
      * @throws IOException if there is an error communicating with Canvas
      */
     @Deprecated
     Optional enrollUser(Enrollment enrollment) throws IllegalArgumentException, IOException;

     /**
      * Enrolls a user in a course
      *
      * @param enrollment partially populated Enrollment object
      * @return optional enrollment
      * @throws IllegalArgumentException when the enrollment courseID is not set
      * @throws IOException if there is an error communicating with Canvas
      */
     Optional enrollUserInCourse(Enrollment enrollment) throws IllegalArgumentException, IOException;

     /**
      * Enrolls a user in a section.
      *
      * @param enrollment partially populated Enrollment object
      * @return optional enrollment
      * @throws IllegalArgumentException when the enrollment courseSectionId is not set
      * @throws IOException if there is an error communicating with Canvas
      */
     Optional enrollUserInSection(Enrollment enrollment) throws IllegalArgumentException, IOException;

     /**
      *
      * Drop a user enrolled in a course passing the UnEnrollOptions string in the task param.
      *
      * @param courseId - Canvas course identifier
      * @param enrollmentId - Canvas enrollment identifier
      * @param unEnrollOption - UnEnrollOption enum value of delete, conclude, inactivate or deactivate
      * @return Populated Enrollment Dropped when successful
      * @throws IOException if there is an error communicating with Canvas
      */
     Optional dropUser(String courseId, String enrollmentId, UnEnrollOptions unEnrollOption) throws IOException;

     /**
      *
      *  Drop a user enrolled in a course using the Unenrollment option of DELETE.
      *
      * @param courseId - Canvas course identifier
      * @param enrollmentId enrollmentId - Canvas enrollment identifier
      * @return Populated Enrollment Dropped when successful
      * @throws IOException if there is an error communicating with Canvas
      */
     Optional dropUser(String courseId, String enrollmentId) throws IOException;
}