edu.ksu.canvas.impl

Class ModuleImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<Module,ModuleReader,CanvasWriter>

edu.ksu.canvas.impl.ModuleImpl

All Implemented Interfaces:

CanvasReader<Module,ModuleReader>, CanvasWriter<Module,CanvasWriter>, ModuleReader

public class ModuleImpl
extends BaseImpl<Module,ModuleReader,CanvasWriter>
implements ModuleReader

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
ModuleImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls)

Method Summary

Modifier and Type	Method and Description
List<Module>	getModulesInCourse(ListModulesOptions options) Retrieve the list of modules in a course.
protected Type	listType()
protected Class<Module>	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

Constructor Detail

ModuleImpl

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

Method Detail

getModulesInCourse

public List<Module> getModulesInCourse(ListModulesOptions options)
                                throws IOException

Description copied from interface: ModuleReader

Retrieve the list of modules in a course.

Specified by:

getModulesInCourse in interface ModuleReader

Parameters:

options - The object holding options for this API call

Returns:

List of the course's modules

Throws:

IOException - When there is an error communicating with Canvas

objectType

protected Class<Module> objectType()

Specified by:

objectType in class BaseImpl<Module,ModuleReader,CanvasWriter>

listType

protected Type listType()

Specified by:

listType in class BaseImpl<Module,ModuleReader,CanvasWriter>