edu.ksu.canvas.impl

Class AssignmentOverrideImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<AssignmentOverride,AssignmentOverrideReader,AssignmentOverrideWriter>

edu.ksu.canvas.impl.AssignmentOverrideImpl

All Implemented Interfaces:

AssignmentOverrideReader, AssignmentOverrideWriter, CanvasReader<AssignmentOverride,AssignmentOverrideReader>, CanvasWriter<AssignmentOverride,AssignmentOverrideWriter>

public class AssignmentOverrideImpl
extends BaseImpl<AssignmentOverride,AssignmentOverrideReader,AssignmentOverrideWriter>
implements AssignmentOverrideReader, AssignmentOverrideWriter

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
AssignmentOverrideImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls)

Method Summary

Modifier and Type	Method and Description
Optional<AssignmentOverride>	createAssignmentOverride(String courseId, AssignmentOverride assignmentOverride) Creates an assignment override in canvas.
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.
protected Type	listType()
protected Class<AssignmentOverride>	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

AssignmentOverrideImpl

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

Method Detail

listAssignmentOverrides

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

Description copied from interface: AssignmentOverrideReader

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

Specified by:

listAssignmentOverrides in interface AssignmentOverrideReader

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

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

Description copied from interface: AssignmentOverrideReader

Returns details of the the override with the given id.

Specified by:

getAssignmentOverride in interface AssignmentOverrideReader

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

createAssignmentOverride

public Optional<AssignmentOverride> createAssignmentOverride(String courseId,
                                                             AssignmentOverride assignmentOverride)
                                                      throws IOException

Description copied from interface: AssignmentOverrideWriter

Creates an assignment override in canvas. The override object must have an assignment ID set.

Specified by:

createAssignmentOverride in interface AssignmentOverrideWriter

Parameters:

courseId - Course that the assignment is in

assignmentOverride - The Override object to create

Returns:

AssignmentOverride object created in Canvas

Throws:

IOException - When there is an error communicating with Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<AssignmentOverride,AssignmentOverrideReader,AssignmentOverrideWriter>

objectType

protected Class<AssignmentOverride> objectType()

Specified by:

objectType in class BaseImpl<AssignmentOverride,AssignmentOverrideReader,AssignmentOverrideWriter>