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

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.Progress;
import edu.ksu.canvas.model.assignment.Submission;
import edu.ksu.canvas.requestOptions.MultipleSubmissionsOptions;

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

public interface SubmissionWriter extends CanvasWriter {

    /**
     * Update the grading and comments on multiple student's assignment submissions in an asynchronous job. By section.
     *
     * @param options      Parameters object containing parameters such as: section_id, assignment_id, student_id,
     *                     posted_grade, text_comment, group_comment, excuse, media_comment_id, media_comment_type.
     * @return             The progress object created by Canvas
     * @throws             IOException If there is an error talking to Canvas
     */
    Optional gradeMultipleSubmissionsBySection(MultipleSubmissionsOptions options)throws IOException;

    /**
     * Update the grading and comments on multiple student's assignment submissions in an asynchronous job. By Course.
     *
     * @param options      Parameters object containing parameters such as: course_id, assignment_id, student_id,
     *                     posted_grade, text_comment, group_comment, excuse, media_comment_id, media_comment_type.
     * @return             The progress object created by Canvas
     * @throws             IOException If there is an error talking to Canvas
     */
    public Optional gradeMultipleSubmissionsByCourse(MultipleSubmissionsOptions options) throws IOException;
}