edu.ksu.canvas.impl

Class SelectiveDataImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<SelectiveData,SelectiveDataReader,CanvasWriter>

edu.ksu.canvas.impl.SelectiveDataImpl

All Implemented Interfaces:

CanvasReader<SelectiveData,SelectiveDataReader>, CanvasWriter<SelectiveData,CanvasWriter>, SelectiveDataReader

public class SelectiveDataImpl
extends BaseImpl<SelectiveData,SelectiveDataReader,CanvasWriter>
implements SelectiveDataReader

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
SelectiveDataImpl(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<SelectiveData>	getAccountSelectiveDataFromMigration(GetSelectiveDataOptions options) Get selective data of an account migration.
List<SelectiveData>	getCourseSelectiveDataFromMigration(GetSelectiveDataOptions options) NOTE : Urls for subitems are expected to be on the same endpoint as the top-level but adding a type parameter The available types can be retrieved in the top-level GET, then a type can be added to the GetSelectiveDataOptions object on the following call
List<SelectiveData>	getGroupSelectiveDataFromMigration(GetSelectiveDataOptions options) Get selective data of a group migration.
List<SelectiveData>	getUserSelectiveDataFromMigration(GetSelectiveDataOptions options) Get selective data of a user migration.
protected Type	listType()
protected Class<SelectiveData>	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

SelectiveDataImpl

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

Method Detail

getCourseSelectiveDataFromMigration

public List<SelectiveData> getCourseSelectiveDataFromMigration(GetSelectiveDataOptions options)
                                                        throws IOException

NOTE : Urls for subitems are expected to be on the same endpoint as the top-level but adding a type parameter The available types can be retrieved in the top-level GET, then a type can be added to the GetSelectiveDataOptions object on the following call

Specified by:

getCourseSelectiveDataFromMigration in interface SelectiveDataReader

Parameters:

options - The destination item ID for the migration, the migration id and the type

Returns:

List of selectable items for the migration

Throws:

IOException - When there is an error communicating with Canvas

getUserSelectiveDataFromMigration

public List<SelectiveData> getUserSelectiveDataFromMigration(GetSelectiveDataOptions options)
                                                      throws IOException

Description copied from interface: SelectiveDataReader

Get selective data of a user migration.

Specified by:

getUserSelectiveDataFromMigration in interface SelectiveDataReader

Parameters:

options - The destination item ID for the migration, the migration id and the type

Returns:

List of selectable items for the migration

Throws:

IOException - When there is an error communicating with Canvas

getGroupSelectiveDataFromMigration

public List<SelectiveData> getGroupSelectiveDataFromMigration(GetSelectiveDataOptions options)
                                                       throws IOException

Description copied from interface: SelectiveDataReader

Get selective data of a group migration.

Specified by:

getGroupSelectiveDataFromMigration in interface SelectiveDataReader

Parameters:

options - The destination item ID for the migration, the migration id and the type

Returns:

List of selectable items for the migration

Throws:

IOException - When there is an error communicating with Canvas

getAccountSelectiveDataFromMigration

public List<SelectiveData> getAccountSelectiveDataFromMigration(GetSelectiveDataOptions options)
                                                         throws IOException

Description copied from interface: SelectiveDataReader

Get selective data of an account migration.

Specified by:

getAccountSelectiveDataFromMigration in interface SelectiveDataReader

Parameters:

options - The destination item ID for the migration, the migration id and the type

Returns:

List of selectable items for the migration

Throws:

IOException - When there is an error communicating with Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<SelectiveData,SelectiveDataReader,CanvasWriter>

objectType

protected Class<SelectiveData> objectType()

Specified by:

objectType in class BaseImpl<SelectiveData,SelectiveDataReader,CanvasWriter>