edu.ksu.canvas.impl

Class ContentMigrationImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<ContentMigration,ContentMigrationReader,ContentMigrationWriter>

edu.ksu.canvas.impl.ContentMigrationImpl

All Implemented Interfaces:

CanvasReader<ContentMigration,ContentMigrationReader>, CanvasWriter<ContentMigration,ContentMigrationWriter>, ContentMigrationReader, ContentMigrationWriter

public class ContentMigrationImpl
extends BaseImpl<ContentMigration,ContentMigrationReader,ContentMigrationWriter>
implements ContentMigrationReader, ContentMigrationWriter

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
ContentMigrationImpl(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<ContentMigration>	createAccountContentMigration(CreateContentMigrationOptions options)
Optional<ContentMigration>	createCourseContentMigration(CreateCourseContentMigrationOptions options)
Optional<ContentMigration>	createGroupContentMigration(CreateContentMigrationOptions options)
Optional<ContentMigration>	createUserContentMigration(CreateContentMigrationOptions options)
Optional<ContentMigration>	getAccountContentMigration(String accountId, Integer id) ACCOUNTS
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) GROUPS
List<ContentMigration>	getGroupContentMigrations(String groupId) Returns a list of group content migrations.
Optional<ContentMigration>	getUserContentMigration(String userId, Integer id) USERS
List<ContentMigration>	getUserContentMigrations(String userId) Returns a list of user content migrations.
protected Type	listType()
protected Class<ContentMigration>	objectType()
Optional<ContentMigration>	updateAccountContentMigration(Integer id, CreateContentMigrationOptions options)
Optional<ContentMigration>	updateCourseContentMigration(Integer id, CreateCourseContentMigrationOptions options)
Optional<ContentMigration>	updateGroupContentMigration(Integer id, CreateContentMigrationOptions options)
Optional<ContentMigration>	updateUserContentMigration(Integer id, CreateContentMigrationOptions options)

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

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

writeAsCanvasUser, writeAsSisUser

Constructor Detail

ContentMigrationImpl

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

Method Detail

getCourseContentMigration

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

Description copied from interface: ContentMigrationReader

Returns a course content migration.

Specified by:

getCourseContentMigration in interface ContentMigrationReader

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

public List<ContentMigration> getCourseContentMigrations(String courseId)
                                                  throws IOException

Description copied from interface: ContentMigrationReader

Returns a list of course content migrations.

Specified by:

getCourseContentMigrations in interface ContentMigrationReader

Parameters:

courseId - The course ID for this API call

Returns:

A ContentMigration list

Throws:

IOException - When there is an error communicating with Canvas

createCourseContentMigration

public Optional<ContentMigration> createCourseContentMigration(CreateCourseContentMigrationOptions options)
                                                        throws IOException

Specified by:

createCourseContentMigration in interface ContentMigrationWriter

Throws:

IOException

updateCourseContentMigration

public Optional<ContentMigration> updateCourseContentMigration(Integer id,
                                                               CreateCourseContentMigrationOptions options)
                                                        throws IOException

Specified by:

updateCourseContentMigration in interface ContentMigrationWriter

Throws:

IOException

getUserContentMigration

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

USERS

Specified by:

getUserContentMigration in interface ContentMigrationReader

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

public List<ContentMigration> getUserContentMigrations(String userId)
                                                throws IOException

Description copied from interface: ContentMigrationReader

Returns a list of user content migrations.

Specified by:

getUserContentMigrations in interface ContentMigrationReader

Parameters:

userId - The user ID for this API call

Returns:

A ContentMigration list

Throws:

IOException - When there is an error communicating with Canvas

createUserContentMigration

public Optional<ContentMigration> createUserContentMigration(CreateContentMigrationOptions options)
                                                      throws IOException

Specified by:

createUserContentMigration in interface ContentMigrationWriter

Throws:

IOException

updateUserContentMigration

public Optional<ContentMigration> updateUserContentMigration(Integer id,
                                                             CreateContentMigrationOptions options)
                                                      throws IOException

Specified by:

updateUserContentMigration in interface ContentMigrationWriter

Throws:

IOException

getGroupContentMigration

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

GROUPS

Specified by:

getGroupContentMigration in interface ContentMigrationReader

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

public List<ContentMigration> getGroupContentMigrations(String groupId)
                                                 throws IOException

Description copied from interface: ContentMigrationReader

Returns a list of group content migrations.

Specified by:

getGroupContentMigrations in interface ContentMigrationReader

Parameters:

groupId - The group ID for this API call

Returns:

A ContentMigration list

Throws:

IOException - When there is an error communicating with Canvas

createGroupContentMigration

public Optional<ContentMigration> createGroupContentMigration(CreateContentMigrationOptions options)
                                                       throws IOException

Specified by:

createGroupContentMigration in interface ContentMigrationWriter

Throws:

IOException

updateGroupContentMigration

public Optional<ContentMigration> updateGroupContentMigration(Integer id,
                                                              CreateContentMigrationOptions options)
                                                       throws IOException

Specified by:

updateGroupContentMigration in interface ContentMigrationWriter

Throws:

IOException

getAccountContentMigration

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

ACCOUNTS

Specified by:

getAccountContentMigration in interface ContentMigrationReader

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

public List<ContentMigration> getAccountContentMigrations(String accountId)
                                                   throws IOException

Description copied from interface: ContentMigrationReader

Returns a list of account content migrations.

Specified by:

getAccountContentMigrations in interface ContentMigrationReader

Parameters:

accountId - The account ID for this API call

Returns:

A ContentMigration list

Throws:

IOException - When there is an error communicating with Canvas

createAccountContentMigration

public Optional<ContentMigration> createAccountContentMigration(CreateContentMigrationOptions options)
                                                         throws IOException

Specified by:

createAccountContentMigration in interface ContentMigrationWriter

Throws:

IOException

updateAccountContentMigration

public Optional<ContentMigration> updateAccountContentMigration(Integer id,
                                                                CreateContentMigrationOptions options)
                                                         throws IOException

Specified by:

updateAccountContentMigration in interface ContentMigrationWriter

Throws:

IOException

listType

protected Type listType()

Specified by:

listType in class BaseImpl<ContentMigration,ContentMigrationReader,ContentMigrationWriter>

objectType

protected Class<ContentMigration> objectType()

Specified by:

objectType in class BaseImpl<ContentMigration,ContentMigrationReader,ContentMigrationWriter>