edu.ksu.canvas.interfaces

Interface AssignmentWriter

All Superinterfaces:

CanvasWriter<Assignment,AssignmentWriter>

All Known Implementing Classes:

AssignmentImpl

public interface AssignmentWriter
extends CanvasWriter<Assignment,AssignmentWriter>

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

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

writeAsCanvasUser, writeAsSisUser

Method Detail

createAssignment

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

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

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

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

Deletes a specified assignment in canvas

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

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

Writes an Assignment object to the Canvas API

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