edu.ksu.canvas.interfaces.EnrollmentTermReader 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.EnrollmentTerm;
import edu.ksu.canvas.requestOptions.GetEnrollmentTermOptions;

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

public interface EnrollmentTermReader  extends CanvasReader {

    /**
     * Retrieve the enrollment terms for a single account.
     * @param options API options available to this call
     * @return the list of enrollment terms for that account
     * @throws IOException When there is an error communicating with Canvas
     */
    List getEnrollmentTerms(GetEnrollmentTermOptions options) throws IOException;

    /**
     * Get a single enrollment term.
     * @param accountId The account ID to look in.
     * @param termId The term ID to lookup.
     * @return an Optional EnrollmentTerm for the ID.
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional getEnrollmentTerm(String accountId, String termId) throws IOException;

}