edu.ksu.canvas.interfaces.RubricReader 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

The newest version!

package edu.ksu.canvas.interfaces;

import edu.ksu.canvas.model.assignment.Rubric;
import edu.ksu.canvas.requestOptions.GetRubricOptions;

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

public interface RubricReader extends CanvasReader {

    /**
     * Get a single rubric by ID from an account.
     * @param options Request parameters
     * @return The requested rubric object associated with an account
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional getRubricInAccount(GetRubricOptions options) throws IOException;

    /**
     * Get a single rubric by ID from a course.
     * @param options Request parameters
     * @return The requested rubric object associated with a course
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional getRubricInCourse(GetRubricOptions options) throws IOException;
}