edu.ksu.canvas.interfaces

Interface AssignmentReader

All Superinterfaces:

CanvasReader<Assignment,AssignmentReader>

All Known Implementing Classes:

AssignmentImpl

public interface AssignmentReader
extends CanvasReader<Assignment,AssignmentReader>

Methods to read information from and about Assignments

Method Summary

Modifier and Type	Method and Description
Optional<Assignment>	getSingleAssignment(GetSingleAssignmentOptions options) Retrieve a specific assignment from Canvas by its Canvas ID number
List<Assignment>	listCourseAssignments(ListCourseAssignmentsOptions options) Retrieve a list of assignments associated with a course
List<Assignment>	listUserAssignments(ListUserAssignmentOptions options) Retrieve a list of assignments associated with the given user/course combination

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

getSingleAssignment

Optional<Assignment> getSingleAssignment(GetSingleAssignmentOptions options)
                                  throws IOException

Retrieve a specific assignment from Canvas by its Canvas ID number

Parameters:

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

Returns:

The assignment returned by Canvas or an empty Optional

Throws:

IOException - When there is an error communicating with Canvas

listCourseAssignments

List<Assignment> listCourseAssignments(ListCourseAssignmentsOptions options)
                                throws IOException

Retrieve a list of assignments associated with a course

Parameters:

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

Returns:

List of assignments in the requested course

Throws:

IOException - When there is an error communicating with Canvas

listUserAssignments

List<Assignment> listUserAssignments(ListUserAssignmentOptions options)
                              throws IOException

Retrieve a list of assignments associated with the given user/course combination

Parameters:

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

Returns:

List of assignments for the user/course combination

Throws:

IOException - When there is an error communicating with Canvas