edu.ksu.canvas.interfaces

Interface AssignmentGroupReader

All Superinterfaces:

CanvasReader<AssignmentGroup,AssignmentGroupReader>

All Known Implementing Classes:

AssignmentGroupImpl

public interface AssignmentGroupReader
extends CanvasReader<AssignmentGroup,AssignmentGroupReader>

Method Summary

Modifier and Type	Method and Description
Optional<AssignmentGroup>	getAssignmentGroup(GetAssignmentGroupOptions options) Returns the requested assignment group by ID
List<AssignmentGroup>	listAssignmentGroup(ListAssignmentGroupOptions options) Return a list of AssignmentGroups that the current user can view or manage.

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

listAssignmentGroup

List<AssignmentGroup> listAssignmentGroup(ListAssignmentGroupOptions options)
                                   throws IOException

Return a list of AssignmentGroups that the current user can view or manage.

Parameters:

options - A mapping of optional parameters for assignment groups

Returns:

List of AssignmentGroups

Throws:

IOException - When there is an error communicating with Canvas

getAssignmentGroup

Optional<AssignmentGroup> getAssignmentGroup(GetAssignmentGroupOptions options)
                                      throws IOException

Returns the requested assignment group by ID

Parameters:

options - Collection of optional parameters to the Canvas API

Returns:

The requested assignment group

Throws:

IOException - When there is an error communicating with Canvas