edu.ksu.canvas.interfaces

Interface EnrollmentTermReader

All Superinterfaces:

CanvasReader<EnrollmentTerm,EnrollmentTermReader>

All Known Implementing Classes:

EnrollmentTermImpl

public interface EnrollmentTermReader
extends CanvasReader<EnrollmentTerm,EnrollmentTermReader>

Method Summary

Modifier and Type	Method and Description
Optional<EnrollmentTerm>	getEnrollmentTerm(String accountId, String termId) Get a single enrollment term.
List<EnrollmentTerm>	getEnrollmentTerms(GetEnrollmentTermOptions options) Retrieve the enrollment terms for a single account.

Methods inherited from interface edu.ksu.canvas.interfaces.CanvasReader

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

getEnrollmentTerms

List<EnrollmentTerm> getEnrollmentTerms(GetEnrollmentTermOptions options)
                                 throws IOException

Retrieve the enrollment terms for a single account.

Parameters:

options - API options available to this call

Returns:

the list of enrollment terms for that account

Throws:

IOException - When there is an error communicating with Canvas

getEnrollmentTerm

Optional<EnrollmentTerm> getEnrollmentTerm(String accountId,
                                           String termId)
                                    throws IOException

Get a single enrollment term.

Parameters:

accountId - The account ID to look in.

termId - The term ID to lookup.

Returns:

an Optional EnrollmentTerm for the ID.

Throws:

IOException - When there is an error communicating with Canvas