edu.ksu.canvas.impl

Class FeatureImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<Feature,FeatureReader,FeatureWriter>

edu.ksu.canvas.impl.FeatureImpl

All Implemented Interfaces:

CanvasReader<Feature,FeatureReader>, CanvasWriter<Feature,FeatureWriter>, FeatureReader

public class FeatureImpl
extends BaseImpl<Feature,FeatureReader,FeatureWriter>
implements FeatureReader

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
FeatureImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls) Construct a new CanvasApi class with an OAuth token

Method Summary

Modifier and Type	Method and Description
List<Feature>	getAccountFeatures(String accountId)
List<Feature>	getCourseFeatures(String courseId)
List<Feature>	getUserFeatures(String userId)
protected Type	listType()
protected Class<Feature>	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

FeatureImpl

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

Construct a new CanvasApi class with an OAuth token

Parameters:

canvasBaseUrl - The base URL of your canvas instance

apiVersion - The version of the Canvas API (currently 1)

oauthToken - OAuth token to use when executing API calls

restClient - a RestClient implementation to use when talking to Canvas

connectTimeout - Timeout in seconds to use when connecting

readTimeout - Timeout in seconds to use when waiting for data to come back from an open connection

paginationPageSize - How many objects to request per page on paginated requests

serializeNulls - Whether or not to include null fields in the serialized JSON. Defaults to false if null

Method Detail

listType

protected Type listType()

Specified by:

listType in class BaseImpl<Feature,FeatureReader,FeatureWriter>

objectType

protected Class<Feature> objectType()

Specified by:

objectType in class BaseImpl<Feature,FeatureReader,FeatureWriter>

getCourseFeatures

public List<Feature> getCourseFeatures(String courseId)
                                throws IOException

Specified by:

getCourseFeatures in interface FeatureReader

Throws:

IOException

getAccountFeatures

public List<Feature> getAccountFeatures(String accountId)
                                 throws IOException

Specified by:

getAccountFeatures in interface FeatureReader

Throws:

IOException

getUserFeatures

public List<Feature> getUserFeatures(String userId)
                              throws IOException

Specified by:

getUserFeatures in interface FeatureReader

Throws:

IOException