edu.ksu.canvas.impl

Class SubmissionImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<Submission,SubmissionReader,SubmissionWriter>

edu.ksu.canvas.impl.SubmissionImpl

All Implemented Interfaces:

CanvasReader<Submission,SubmissionReader>, CanvasWriter<Submission,SubmissionWriter>, SubmissionReader, SubmissionWriter

public class SubmissionImpl
extends BaseImpl<Submission,SubmissionReader,SubmissionWriter>
implements SubmissionReader, SubmissionWriter

Field Summary

Fields inherited from class edu.ksu.canvas.impl.BaseImpl

apiVersion, canvasBaseUrl, canvasMessenger, masqueradeAs, masqueradeType, oauthToken, paginationPageSize, responseCallback, responseParser, serializeNulls

Constructor Summary

Constructors

Constructor and Description
SubmissionImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls) Construct a new CanvasApi class with an OAuth token

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
Optional<Progress>	gradeMultipleSubmissionsByCourse(MultipleSubmissionsOptions options) Update the grading and comments on multiple student's assignment submissions in an asynchronous job.
Optional<Progress>	gradeMultipleSubmissionsBySection(MultipleSubmissionsOptions options) Update the grading and comments on multiple student's assignment submissions in an asynchronous job.
List<Submission>	listCourseSubmissionsForMultipleAssignments(GetSubmissionsOptions options) Return a list of all assignment submissions for a course (either for a single user, or all users).
protected Type	listType()
protected Class<Submission>	objectType()

Methods inherited from class edu.ksu.canvas.impl.BaseImpl

buildCanvasUrl, encode, getFromCanvas, getListFromCanvas, parseListOfResponses, readAsCanvasUser, readAsSisUser, withCallback, writeAsCanvasUser, writeAsSisUser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

readAsCanvasUser, readAsSisUser, withCallback

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

writeAsCanvasUser, writeAsSisUser

Constructor Detail

SubmissionImpl

public SubmissionImpl(String canvasBaseUrl,
                      Integer apiVersion,
                      OauthToken oauthToken,
                      RestClient restClient,
                      int connectTimeout,
                      int readTimeout,
                      Integer paginationPageSize,
                      Boolean serializeNulls)

Construct a new CanvasApi class with an OAuth token

Parameters:

canvasBaseUrl - The base URL of your canvas instance

apiVersion - The version of the Canvas API (currently 1)

oauthToken - OAuth token to use when executing API calls

restClient - a RestClient implementation to use when talking to Canvas

connectTimeout - Timeout in seconds to use when connecting

readTimeout - Timeout in seconds to use when waiting for data to come back from an open connection

paginationPageSize - How many objects to request per page on paginated requests

serializeNulls - Whether or not to include null fields in the serialized JSON. Defaults to false if null

Method Detail

getCourseSubmissions

public List<Submission> getCourseSubmissions(GetSubmissionsOptions options)
                                      throws IOException

Description copied from interface: SubmissionReader

Retrieve a list of assignment submissions from a course

Specified by:

getCourseSubmissions in interface SubmissionReader

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

public List<Submission> listCourseSubmissionsForMultipleAssignments(GetSubmissionsOptions options)
                                                             throws IOException

Description copied from interface: SubmissionReader

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

Specified by:

listCourseSubmissionsForMultipleAssignments in interface SubmissionReader

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

public List<Submission> getSectionSubmissions(GetSubmissionsOptions options)
                                       throws IOException

Description copied from interface: SubmissionReader

Retrieve a list of assignment submissions from a section

Specified by:

getSectionSubmissions in interface SubmissionReader

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

public Optional<Submission> getSingleCourseSubmission(GetSubmissionsOptions options)
                                               throws IOException

Description copied from interface: SubmissionReader

Retrieve a single assignment submission from a course

Specified by:

getSingleCourseSubmission in interface SubmissionReader

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

public Optional<Submission> getSingleSectionSubmission(GetSubmissionsOptions options)
                                                throws IOException

Description copied from interface: SubmissionReader

Retrieve a single assignment submission from a section

Specified by:

getSingleSectionSubmission in interface SubmissionReader

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

gradeMultipleSubmissionsBySection

public Optional<Progress> gradeMultipleSubmissionsBySection(MultipleSubmissionsOptions options)
                                                     throws IOException

Description copied from interface: SubmissionWriter

Update the grading and comments on multiple student's assignment submissions in an asynchronous job. By section.

Specified by:

gradeMultipleSubmissionsBySection in interface SubmissionWriter

Parameters:

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.

Returns:

The progress object created by Canvas

Throws:

IOException - If there is an error talking to Canvas

gradeMultipleSubmissionsByCourse

public Optional<Progress> gradeMultipleSubmissionsByCourse(MultipleSubmissionsOptions options)
                                                    throws IOException

Description copied from interface: SubmissionWriter

Update the grading and comments on multiple student's assignment submissions in an asynchronous job. By Course.

Specified by:

gradeMultipleSubmissionsByCourse in interface SubmissionWriter

Parameters:

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.

Returns:

The progress object created by Canvas

Throws:

IOException - If there is an error talking to Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<Submission,SubmissionReader,SubmissionWriter>

objectType

protected Class<Submission> objectType()

Specified by:

objectType in class BaseImpl<Submission,SubmissionReader,SubmissionWriter>