edu.ksu.canvas.interfaces.SelectiveDataReader 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.SelectiveData;
import edu.ksu.canvas.requestOptions.GetSelectiveDataOptions;

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

public interface SelectiveDataReader extends CanvasReader {
    /**
     * Get selective data of a course migration.
     * @param options The destination item ID for the migration, the migration id and the type
     * @return List of selectable items for the migration
     * @throws IOException When there is an error communicating with Canvas
     */
    List getCourseSelectiveDataFromMigration(GetSelectiveDataOptions options) throws IOException;

    /**
     * Get selective data of a user migration.
     * @param options The destination item ID for the migration, the migration id and the type
     * @return List of selectable items for the migration
     * @throws IOException When there is an error communicating with Canvas
     */
    List getUserSelectiveDataFromMigration(GetSelectiveDataOptions options) throws IOException;

    /**
     * Get selective data of a group migration.
     * @param options The destination item ID for the migration, the migration id and the type
     * @return List of selectable items for the migration
     * @throws IOException When there is an error communicating with Canvas
     */
    List getGroupSelectiveDataFromMigration(GetSelectiveDataOptions options) throws IOException;

    /**
     * Get selective data of an account migration.
     * @param options The destination item ID for the migration, the migration id and the type
     * @return List of selectable items for the migration
     * @throws IOException When there is an error communicating with Canvas
     */
    List getAccountSelectiveDataFromMigration(GetSelectiveDataOptions options) throws IOException;
}