edu.ksu.canvas.impl

Class MigrationIssueImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<MigrationIssue,MigrationIssueReader,CanvasWriter>

edu.ksu.canvas.impl.MigrationIssueImpl

All Implemented Interfaces:

CanvasReader<MigrationIssue,MigrationIssueReader>, CanvasWriter<MigrationIssue,CanvasWriter>, MigrationIssueReader

public class MigrationIssueImpl
extends BaseImpl<MigrationIssue,MigrationIssueReader,CanvasWriter>
implements MigrationIssueReader

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
MigrationIssueImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls)

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.
protected Type	listType()
protected Class<MigrationIssue>	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

MigrationIssueImpl

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

Method Detail

getCourseMigrationIssues

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

Description copied from interface: MigrationIssueReader

Returns a list migration issues.

Specified by:

getCourseMigrationIssues in interface MigrationIssueReader

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

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

Description copied from interface: MigrationIssueReader

Returns a migration issue.

Specified by:

getCourseMigrationIssue in interface MigrationIssueReader

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

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

Description copied from interface: MigrationIssueReader

Returns a list migration issues.

Specified by:

getUserMigrationIssues in interface MigrationIssueReader

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

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

Description copied from interface: MigrationIssueReader

Returns a migration issue.

Specified by:

getUserMigrationIssue in interface MigrationIssueReader

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

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

Description copied from interface: MigrationIssueReader

Returns a list migration issues.

Specified by:

getGroupMigrationIssues in interface MigrationIssueReader

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

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

Description copied from interface: MigrationIssueReader

Returns a migration issue.

Specified by:

getGroupMigrationIssue in interface MigrationIssueReader

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

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

Description copied from interface: MigrationIssueReader

Returns a list migration issues.

Specified by:

getAccountMigrationIssues in interface MigrationIssueReader

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

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

Description copied from interface: MigrationIssueReader

Returns a migration issue.

Specified by:

getAccountMigrationIssue in interface MigrationIssueReader

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

listType

protected Type listType()

Specified by:

listType in class BaseImpl<MigrationIssue,MigrationIssueReader,CanvasWriter>

objectType

protected Class<MigrationIssue> objectType()

Specified by:

objectType in class BaseImpl<MigrationIssue,MigrationIssueReader,CanvasWriter>