edu.ksu.canvas.interfaces

Interface AssignmentOverrideReader

All Superinterfaces:

CanvasReader<AssignmentOverride,AssignmentOverrideReader>

All Known Implementing Classes:

AssignmentOverrideImpl

public interface AssignmentOverrideReader
extends CanvasReader<AssignmentOverride,AssignmentOverrideReader>

Method Summary

Modifier and Type	Method and Description
Optional<AssignmentOverride>	getAssignmentOverride(String courseId, Integer assignmentId, Integer overrideId) Returns details of the the override with the given id.
List<AssignmentOverride>	listAssignmentOverrides(String courseId, Integer assignmentId) Returns the list of overrides for this assignment that target sections/groups/students visible to the current user.

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

listAssignmentOverrides

List<AssignmentOverride> listAssignmentOverrides(String courseId,
                                                 Integer assignmentId)
                                          throws IOException

Returns the list of overrides for this assignment that target sections/groups/students visible to the current user.

Parameters:

courseId - Canvas course ID or "sis_course_id:1234" for SIS course ID

assignmentId - Canvas assignment ID

Returns:

List of assignment overrides

Throws:

IOException - When there is an error communicating with Canvas

getAssignmentOverride

Optional<AssignmentOverride> getAssignmentOverride(String courseId,
                                                   Integer assignmentId,
                                                   Integer overrideId)
                                            throws IOException

Returns details of the the override with the given id.

Parameters:

courseId - Canvas course ID or "sis_course_id:1234" for SIS course ID

assignmentId - Canvas assignment ID

overrideId - Canvas ID of the specific assignment override to query for

Returns:

The requested assigment override object

Throws:

IOException - When there is an error communicating with Canvas