edu.ksu.canvas.impl

Class AdminImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<AccountAdmin,AdminReader,AdminWriter>

edu.ksu.canvas.impl.AdminImpl

All Implemented Interfaces:

AdminReader, AdminWriter, CanvasReader<AccountAdmin,AdminReader>, CanvasWriter<AccountAdmin,AdminWriter>

public class AdminImpl
extends BaseImpl<AccountAdmin,AdminReader,AdminWriter>
implements AdminReader, AdminWriter

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
AdminImpl(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<AccountAdmin>	listAccountAdmins(ListAccountAdminsOptions options) Return a list of account admins that the current user can view or manage.
protected Type	listType()
protected Class<AccountAdmin>	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

AdminImpl

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

Method Detail

listAccountAdmins

public List<AccountAdmin> listAccountAdmins(ListAccountAdminsOptions options)
                                     throws IOException

Description copied from interface: AdminReader

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

Specified by:

listAccountAdmins in interface AdminReader

Parameters:

options - Object encapsulating parameters to the list accounts API call

Returns:

List of account admins

Throws:

IOException - When there is an error communicating with Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<AccountAdmin,AdminReader,AdminWriter>

objectType

protected Class<AccountAdmin> objectType()

Specified by:

objectType in class BaseImpl<AccountAdmin,AdminReader,AdminWriter>