edu.ksu.canvas.interfaces

Interface RoleReader

All Superinterfaces:

CanvasReader<Role,RoleReader>

All Known Implementing Classes:

RoleImpl

public interface RoleReader
extends CanvasReader<Role,RoleReader>

Method Summary

Modifier and Type	Method and Description
List<Role>	listRoles(ListRolesOptions options) Return a list of roles for an account.

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

listRoles

List<Role> listRoles(ListRolesOptions options)
              throws IOException

Return a list of roles for an account.

Parameters:

options - Object encapsulating parameters to the list accounts API call

Returns:

List of roles

Throws:

IOException - When there is an error communicating with Canvas