edu.ksu.canvas.interfaces

Interface ContentMigrationReader

All Superinterfaces:

CanvasReader<ContentMigration,ContentMigrationReader>

All Known Implementing Classes:

ContentMigrationImpl

public interface ContentMigrationReader
extends CanvasReader<ContentMigration,ContentMigrationReader>

Method Summary

Modifier and Type	Method and Description
Optional<ContentMigration>	getAccountContentMigration(String accountId, Integer id) Returns a account content migration.
List<ContentMigration>	getAccountContentMigrations(String accountId) Returns a list of account content migrations.
Optional<ContentMigration>	getCourseContentMigration(String courseId, Integer id) Returns a course content migration.
List<ContentMigration>	getCourseContentMigrations(String courseId) Returns a list of course content migrations.
Optional<ContentMigration>	getGroupContentMigration(String groupId, Integer id) Returns a group content migration.
List<ContentMigration>	getGroupContentMigrations(String groupId) Returns a list of group content migrations.
Optional<ContentMigration>	getUserContentMigration(String userId, Integer id) Returns a user content migration.
List<ContentMigration>	getUserContentMigrations(String userId) Returns a list of user content migrations.

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

getCourseContentMigration

Optional<ContentMigration> getCourseContentMigration(String courseId,
                                                     Integer id)
                                              throws IOException

Returns a course content migration.

Parameters:

courseId - The course ID for this API call

id - The Canvas ID of the content migration to query

Returns:

A ContentMigration object

Throws:

IOException - When there is an error communicating with Canvas

getCourseContentMigrations

List<ContentMigration> getCourseContentMigrations(String courseId)
                                           throws IOException

Returns a list of course content migrations.

Parameters:

courseId - The course ID for this API call

Returns:

A ContentMigration list

Throws:

IOException - When there is an error communicating with Canvas

getUserContentMigration

Optional<ContentMigration> getUserContentMigration(String userId,
                                                   Integer id)
                                            throws IOException

Returns a user content migration.

Parameters:

userId - The user ID for this API call

id - The Canvas ID of the content migration to query

Returns:

A ContentMigration object

Throws:

IOException - When there is an error communicating with Canvas

getUserContentMigrations

List<ContentMigration> getUserContentMigrations(String userId)
                                         throws IOException

Returns a list of user content migrations.

Parameters:

userId - The user ID for this API call

Returns:

A ContentMigration list

Throws:

IOException - When there is an error communicating with Canvas

getGroupContentMigration

Optional<ContentMigration> getGroupContentMigration(String groupId,
                                                    Integer id)
                                             throws IOException

Returns a group content migration.

Parameters:

groupId - The group ID for this API call

id - The Canvas ID of the content migration to query

Returns:

A ContentMigration object

Throws:

IOException - When there is an error communicating with Canvas

getGroupContentMigrations

List<ContentMigration> getGroupContentMigrations(String groupId)
                                          throws IOException

Returns a list of group content migrations.

Parameters:

groupId - The group ID for this API call

Returns:

A ContentMigration list

Throws:

IOException - When there is an error communicating with Canvas

getAccountContentMigration

Optional<ContentMigration> getAccountContentMigration(String accountId,
                                                      Integer id)
                                               throws IOException

Returns a account content migration.

Parameters:

accountId - The account ID for this API call

id - The Canvas ID of the content migration to query

Returns:

A ContentMigration object

Throws:

IOException - When there is an error communicating with Canvas

getAccountContentMigrations

List<ContentMigration> getAccountContentMigrations(String accountId)
                                            throws IOException

Returns a list of account content migrations.

Parameters:

accountId - The account ID for this API call

Returns:

A ContentMigration list

Throws:

IOException - When there is an error communicating with Canvas