edu.ksu.canvas.interfaces.ContentMigrationReader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of canvas-api Show documentation
A native Java library to talk to the Canvas REST API
There is a newer version: 2.0.0
package edu.ksu.canvas.interfaces;

import edu.ksu.canvas.model.ContentMigration;

import java.io.IOException;
import java.util.List;
import java.util.Optional;

public interface ContentMigrationReader extends CanvasReader {
    /**
     * Returns a course content migration.
     * @param courseId The course ID for this API call
     * @param id The Canvas ID of the content migration to query
     * @return A ContentMigration object
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional getCourseContentMigration(String courseId, Integer id) throws IOException;

    /**
     * Returns a list of course content migrations.
     * @param courseId The course ID for this API call
     * @return A ContentMigration list
     * @throws IOException When there is an error communicating with Canvas
     */
    List getCourseContentMigrations(String courseId) throws IOException;

    /**
     * Returns a user content migration.
     * @param userId The user ID for this API call
     * @param id The Canvas ID of the content migration to query
     * @return A ContentMigration object
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional getUserContentMigration(String userId, Integer id) throws IOException;

    /**
     * Returns a list of user content migrations.
     * @param userId The user ID for this API call
     * @return A ContentMigration list
     * @throws IOException When there is an error communicating with Canvas
     */
    List getUserContentMigrations(String userId) throws IOException;

    /**
     * Returns a group content migration.
     * @param groupId The group ID for this API call
     * @param id The Canvas ID of the content migration to query
     * @return A ContentMigration object
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional getGroupContentMigration(String groupId, Integer id) throws IOException;

    /**
     * Returns a list of group content migrations.
     * @param groupId The group ID for this API call
     * @return A ContentMigration list
     * @throws IOException When there is an error communicating with Canvas
     */
    List getGroupContentMigrations(String groupId) throws IOException;

    /**
     * Returns a account content migration.
     * @param accountId The account ID for this API call
     * @param id The Canvas ID of the content migration to query
     * @return A ContentMigration object
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional getAccountContentMigration(String accountId, Integer id) throws IOException;

    /**
     * Returns a list of account content migrations.
     * @param accountId The account ID for this API call
     * @return A ContentMigration list
     * @throws IOException When there is an error communicating with Canvas
     */
    List getAccountContentMigrations(String accountId) throws IOException;
}