edu.ksu.canvas.impl

Class EnrollmentTermImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<EnrollmentTerm,EnrollmentTermReader,EnrollmentTermWriter>

edu.ksu.canvas.impl.EnrollmentTermImpl

All Implemented Interfaces:

CanvasReader<EnrollmentTerm,EnrollmentTermReader>, CanvasWriter<EnrollmentTerm,EnrollmentTermWriter>, EnrollmentTermReader, EnrollmentTermWriter

public class EnrollmentTermImpl
extends BaseImpl<EnrollmentTerm,EnrollmentTermReader,EnrollmentTermWriter>
implements EnrollmentTermReader, EnrollmentTermWriter

Field Summary

Fields inherited from class edu.ksu.canvas.impl.BaseImpl

apiVersion, canvasBaseUrl, canvasMessenger, masqueradeAs, masqueradeType, oauthToken, paginationPageSize, responseCallback, responseParser, serializeNulls

Constructor Summary

Constructors

Constructor and Description
EnrollmentTermImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls)

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.
protected Type	listType()
protected Class<EnrollmentTerm>	objectType()

Methods inherited from class edu.ksu.canvas.impl.BaseImpl

buildCanvasUrl, encode, getFromCanvas, getListFromCanvas, parseListOfResponses, readAsCanvasUser, readAsSisUser, withCallback, writeAsCanvasUser, writeAsSisUser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

readAsCanvasUser, readAsSisUser, withCallback

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

writeAsCanvasUser, writeAsSisUser

Constructor Detail

EnrollmentTermImpl

public EnrollmentTermImpl(String canvasBaseUrl,
                          Integer apiVersion,
                          OauthToken oauthToken,
                          RestClient restClient,
                          int connectTimeout,
                          int readTimeout,
                          Integer paginationPageSize,
                          Boolean serializeNulls)

Method Detail

getEnrollmentTerms

public List<EnrollmentTerm> getEnrollmentTerms(GetEnrollmentTermOptions options)
                                        throws IOException

Description copied from interface: EnrollmentTermReader

Retrieve the enrollment terms for a single account.

Specified by:

getEnrollmentTerms in interface EnrollmentTermReader

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

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

Description copied from interface: EnrollmentTermReader

Get a single enrollment term.

Specified by:

getEnrollmentTerm in interface EnrollmentTermReader

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

listType

protected Type listType()

Specified by:

listType in class BaseImpl<EnrollmentTerm,EnrollmentTermReader,EnrollmentTermWriter>

objectType

protected Class<EnrollmentTerm> objectType()

Specified by:

objectType in class BaseImpl<EnrollmentTerm,EnrollmentTermReader,EnrollmentTermWriter>