edu.ksu.canvas.impl

Class RoleImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<Role,RoleReader,RoleWriter>

edu.ksu.canvas.impl.RoleImpl

All Implemented Interfaces:

CanvasReader<Role,RoleReader>, CanvasWriter<Role,RoleWriter>, RoleReader, RoleWriter

public class RoleImpl
extends BaseImpl<Role,RoleReader,RoleWriter>
implements RoleReader, RoleWriter

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
RoleImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls)

Method Summary

Modifier and Type	Method and Description
List<Role>	listRoles(ListRolesOptions options) Return a list of roles for an account.
protected Type	listType()
protected Class<Role>	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

RoleImpl

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

Method Detail

listRoles

public List<Role> listRoles(ListRolesOptions options)
                     throws IOException

Description copied from interface: RoleReader

Return a list of roles for an account.

Specified by:

listRoles in interface RoleReader

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

listType

protected Type listType()

Specified by:

listType in class BaseImpl<Role,RoleReader,RoleWriter>

objectType

protected Class<Role> objectType()

Specified by:

objectType in class BaseImpl<Role,RoleReader,RoleWriter>