edu.ksu.canvas.impl

Class AssignmentImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<Assignment,AssignmentReader,AssignmentWriter>

edu.ksu.canvas.impl.AssignmentImpl

All Implemented Interfaces:

AssignmentReader, AssignmentWriter, CanvasReader<Assignment,AssignmentReader>, CanvasWriter<Assignment,AssignmentWriter>

public class AssignmentImpl
extends BaseImpl<Assignment,AssignmentReader,AssignmentWriter>
implements AssignmentReader, AssignmentWriter

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
AssignmentImpl(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<Assignment>	createAssignment(String courseId, Assignment assignment) Create an assignment in Canvas.
Optional<Assignment>	deleteAssignment(String courseId, Integer assignmentId) Deletes a specified assignment in canvas
Optional<Assignment>	editAssignment(String courseId, Assignment assignment) Writes an Assignment object to the Canvas API
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
protected Type	listType()
List<Assignment>	listUserAssignments(ListUserAssignmentOptions options) Retrieve a list of assignments associated with the given user/course combination
protected Class<Assignment>	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

AssignmentImpl

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

Method Detail

listCourseAssignments

public List<Assignment> listCourseAssignments(ListCourseAssignmentsOptions options)
                                       throws IOException

Description copied from interface: AssignmentReader

Retrieve a list of assignments associated with a course

Specified by:

listCourseAssignments in interface AssignmentReader

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

public List<Assignment> listUserAssignments(ListUserAssignmentOptions options)
                                     throws IOException

Description copied from interface: AssignmentReader

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

Specified by:

listUserAssignments in interface AssignmentReader

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

getSingleAssignment

public Optional<Assignment> getSingleAssignment(GetSingleAssignmentOptions options)
                                         throws IOException

Description copied from interface: AssignmentReader

Retrieve a specific assignment from Canvas by its Canvas ID number

Specified by:

getSingleAssignment in interface AssignmentReader

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

createAssignment

public Optional<Assignment> createAssignment(String courseId,
                                             Assignment assignment)
                                      throws IOException

Description copied from interface: AssignmentWriter

Create an assignment in Canvas. The only required field is name.

Specified by:

createAssignment in interface AssignmentWriter

Parameters:

courseId - ID of the course to create the assignment in

assignment - Assignment object to create. Must have at least a name set

Returns:

The created assignment object

Throws:

IOException - When there is an error communicating with Canvas

deleteAssignment

public Optional<Assignment> deleteAssignment(String courseId,
                                             Integer assignmentId)
                                      throws IOException

Description copied from interface: AssignmentWriter

Deletes a specified assignment in canvas

Specified by:

deleteAssignment in interface AssignmentWriter

Parameters:

courseId - Course ID of course to delete assignment from

assignmentId - Assignment ID of assignment to delete

Returns:

The deleted Assignment object as returned by the Canvas API

Throws:

IOException - When there is an error communicating with Canvas

editAssignment

public Optional<Assignment> editAssignment(String courseId,
                                           Assignment assignment)
                                    throws IOException

Description copied from interface: AssignmentWriter

Writes an Assignment object to the Canvas API

Specified by:

editAssignment in interface AssignmentWriter

Parameters:

courseId - Course ID that this assignment is associated with

assignment - The assignment settings to write to the API

Returns:

The modified Assignment returned by the API

Throws:

IOException - When there is an error communicating with Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<Assignment,AssignmentReader,AssignmentWriter>

objectType

protected Class<Assignment> objectType()

Specified by:

objectType in class BaseImpl<Assignment,AssignmentReader,AssignmentWriter>