edu.ksu.canvas.interfaces

Interface MigrationIssueReader

All Superinterfaces:

CanvasReader<MigrationIssue,MigrationIssueReader>

All Known Implementing Classes:

MigrationIssueImpl

public interface MigrationIssueReader
extends CanvasReader<MigrationIssue,MigrationIssueReader>

Method Summary

Modifier and Type	Method and Description
Optional<MigrationIssue>	getAccountMigrationIssue(String accountId, Integer migrationId, Integer issueId) Returns a migration issue.
List<MigrationIssue>	getAccountMigrationIssues(String accountId, Integer migrationId) Returns a list migration issues.
Optional<MigrationIssue>	getCourseMigrationIssue(String courseId, Integer migrationId, Integer issueId) Returns a migration issue.
List<MigrationIssue>	getCourseMigrationIssues(String courseId, Integer migrationId) Returns a list migration issues.
Optional<MigrationIssue>	getGroupMigrationIssue(String groupId, Integer migrationId, Integer issueId) Returns a migration issue.
List<MigrationIssue>	getGroupMigrationIssues(String groupId, Integer migrationId) Returns a list migration issues.
Optional<MigrationIssue>	getUserMigrationIssue(String userId, Integer migrationId, Integer issueId) Returns a migration issue.
List<MigrationIssue>	getUserMigrationIssues(String userId, Integer migrationId) Returns a list migration issues.

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

getCourseMigrationIssues

List<MigrationIssue> getCourseMigrationIssues(String courseId,
                                              Integer migrationId)
                                       throws IOException

Returns a list migration issues.

Parameters:

courseId - The destination course ID for the migration

migrationId - The Canvas ID of the content migration

Returns:

List of migration issues

Throws:

IOException - When there is an error communicating with Canvas

getCourseMigrationIssue

Optional<MigrationIssue> getCourseMigrationIssue(String courseId,
                                                 Integer migrationId,
                                                 Integer issueId)
                                          throws IOException

Returns a migration issue.

Parameters:

courseId - The destination course ID for the migration

migrationId - The Canvas ID of the content migration

issueId - The Canvas ID of the migration issue

Returns:

A migration issue

Throws:

IOException - When there is an error communicating with Canvas

getUserMigrationIssues

List<MigrationIssue> getUserMigrationIssues(String userId,
                                            Integer migrationId)
                                     throws IOException

Returns a list migration issues.

Parameters:

userId - The user ID for the migration

migrationId - The Canvas ID of the content migration

Returns:

List of migration issues

Throws:

IOException - When there is an error communicating with Canvas

getUserMigrationIssue

Optional<MigrationIssue> getUserMigrationIssue(String userId,
                                               Integer migrationId,
                                               Integer issueId)
                                        throws IOException

Returns a migration issue.

Parameters:

userId - The user ID for the migration

migrationId - The Canvas ID of the content migration

issueId - The Canvas ID of the migration issue

Returns:

A migration issue

Throws:

IOException - When there is an error communicating with Canvas

getGroupMigrationIssues

List<MigrationIssue> getGroupMigrationIssues(String groupId,
                                             Integer migrationId)
                                      throws IOException

Returns a list migration issues.

Parameters:

groupId - The group ID for the migration

migrationId - The Canvas ID of the content migration

Returns:

List of migration issues

Throws:

IOException - When there is an error communicating with Canvas

getGroupMigrationIssue

Optional<MigrationIssue> getGroupMigrationIssue(String groupId,
                                                Integer migrationId,
                                                Integer issueId)
                                         throws IOException

Returns a migration issue.

Parameters:

groupId - The group ID for the migration

migrationId - The Canvas ID of the content migration

issueId - The Canvas ID of the migration issue

Returns:

A migration issue

Throws:

IOException - When there is an error communicating with Canvas

getAccountMigrationIssues

List<MigrationIssue> getAccountMigrationIssues(String accountId,
                                               Integer migrationId)
                                        throws IOException

Returns a list migration issues.

Parameters:

accountId - The account ID for the migration

migrationId - The Canvas ID of the content migration

Returns:

List of migration issues

Throws:

IOException - When there is an error communicating with Canvas

getAccountMigrationIssue

Optional<MigrationIssue> getAccountMigrationIssue(String accountId,
                                                  Integer migrationId,
                                                  Integer issueId)
                                           throws IOException

Returns a migration issue.

Parameters:

accountId - The account ID for the migration

migrationId - The Canvas ID of the content migration

issueId - The Canvas ID of the migration issue

Returns:

A migration issue

Throws:

IOException - When there is an error communicating with Canvas