edu.ksu.canvas.interfaces

Interface AssignmentGroupWriter

All Superinterfaces:

CanvasWriter<AssignmentGroup,AssignmentGroupWriter>

All Known Implementing Classes:

AssignmentGroupImpl

public interface AssignmentGroupWriter
extends CanvasWriter<AssignmentGroup,AssignmentGroupWriter>

Method Summary

Modifier and Type	Method and Description
Optional<AssignmentGroup>	createAssignmentGroup(String courseId, AssignmentGroup assignmentGroup) Creates an assignment group in Canvas.
Optional<AssignmentGroup>	deleteAssignmentGroup(DeleteAssignmentGroupOptions options) Delete an assignment group from Canvas.
Optional<AssignmentGroup>	editAssignmentGroup(String courseId, AssignmentGroup assignmentGroup) Modify an existing assignment group in Canvas.

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

writeAsCanvasUser, writeAsSisUser

Method Detail

createAssignmentGroup

Optional<AssignmentGroup> createAssignmentGroup(String courseId,
                                                AssignmentGroup assignmentGroup)
                                         throws IOException

Creates an assignment group in Canvas.

Parameters:

courseId - Course that the assignment group is in

assignmentGroup - The Assignment Group object to create

Returns:

AssignmentGroup object created in Canvas

Throws:

IOException - When there is an error communicating with Canvas

editAssignmentGroup

Optional<AssignmentGroup> editAssignmentGroup(String courseId,
                                              AssignmentGroup assignmentGroup)
                                       throws IOException

Modify an existing assignment group in Canvas. It must have an ID assigned by Canvas.

Parameters:

courseId - Course ID of the course containing the assignment group to edit

assignmentGroup - Modified assignment group to save

Returns:

Modified assignment group from Canvas

Throws:

IOException - When there is an error communicating with Canvas

deleteAssignmentGroup

Optional<AssignmentGroup> deleteAssignmentGroup(DeleteAssignmentGroupOptions options)
                                         throws IOException

Delete an assignment group from Canvas. Optionally, move assignments in the deleted group to a new group. If not specified, these assignments are deleted.

Parameters:

options - Collection of optional parameters for the Canvas API call

Returns:

The deleted assignment group object

Throws:

IOException - When there is an error communicating with Canvas