edu.ksu.canvas.interfaces

Interface SelectiveDataReader

All Superinterfaces:

CanvasReader<SelectiveData,SelectiveDataReader>

All Known Implementing Classes:

SelectiveDataImpl

public interface SelectiveDataReader
extends CanvasReader<SelectiveData,SelectiveDataReader>

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) Get selective data of a course migration.
List<SelectiveData>	getGroupSelectiveDataFromMigration(GetSelectiveDataOptions options) Get selective data of a group migration.
List<SelectiveData>	getUserSelectiveDataFromMigration(GetSelectiveDataOptions options) Get selective data of a user migration.

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

getCourseSelectiveDataFromMigration

List<SelectiveData> getCourseSelectiveDataFromMigration(GetSelectiveDataOptions options)
                                                 throws IOException

Get selective data of a course migration.

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

List<SelectiveData> getUserSelectiveDataFromMigration(GetSelectiveDataOptions options)
                                               throws IOException

Get selective data of a user migration.

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

List<SelectiveData> getGroupSelectiveDataFromMigration(GetSelectiveDataOptions options)
                                                throws IOException

Get selective data of a group migration.

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

List<SelectiveData> getAccountSelectiveDataFromMigration(GetSelectiveDataOptions options)
                                                  throws IOException

Get selective data of an account migration.

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