edu.ksu.canvas.interfaces

Interface SubmissionReader

All Superinterfaces:

CanvasReader<Submission,SubmissionReader>

All Known Implementing Classes:

SubmissionImpl

public interface SubmissionReader
extends CanvasReader<Submission,SubmissionReader>

Method Summary

Modifier and Type	Method and Description
List<Submission>	getCourseSubmissions(GetSubmissionsOptions options) Retrieve a list of assignment submissions from a course
List<Submission>	getSectionSubmissions(GetSubmissionsOptions options) Retrieve a list of assignment submissions from a section
Optional<Submission>	getSingleCourseSubmission(GetSubmissionsOptions options) Retrieve a single assignment submission from a course
Optional<Submission>	getSingleSectionSubmission(GetSubmissionsOptions options) Retrieve a single assignment submission from a section
List<Submission>	listCourseSubmissionsForMultipleAssignments(GetSubmissionsOptions options) Return a list of all assignment submissions for a course (either for a single user, or all users).

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

getCourseSubmissions

List<Submission> getCourseSubmissions(GetSubmissionsOptions options)
                               throws IOException

Retrieve a list of assignment submissions from a course

Parameters:

options - Options class containing required and optional parameters for this API call

Returns:

List of assignment submissions in the course with the course ID

Throws:

IOException - When there is an error communicating with Canvas

listCourseSubmissionsForMultipleAssignments

List<Submission> listCourseSubmissionsForMultipleAssignments(GetSubmissionsOptions options)
                                                      throws IOException

Return a list of all assignment submissions for a course (either for a single user, or all users).

Parameters:

options - Options class containing required and optional parameters for this API call

Returns:

List of assignment submissions in the course with the course ID

Throws:

IOException - When there is an error communicating with Canvas

getSectionSubmissions

List<Submission> getSectionSubmissions(GetSubmissionsOptions options)
                                throws IOException

Retrieve a list of assignment submissions from a section

Parameters:

options - Options class containing required and optional parameters for this API call

Returns:

List of assignment submissions in the section with the section ID

Throws:

IOException - When there is an error communicating with Canvas

getSingleCourseSubmission

Optional<Submission> getSingleCourseSubmission(GetSubmissionsOptions options)
                                        throws IOException

Retrieve a single assignment submission from a course

Parameters:

options - Options class containing required and optional parameters for this API call

Returns:

The requested Submission object given the course, assignment and user

Throws:

IOException - When there is an error communicating with Canvas

getSingleSectionSubmission

Optional<Submission> getSingleSectionSubmission(GetSubmissionsOptions options)
                                         throws IOException

Retrieve a single assignment submission from a section

Parameters:

options - Options class containing required and optional parameters for this API call

Returns:

The requested Submission object given the section, assignment and user

Throws:

IOException - When there is an error communicating with Canvas