edu.ksu.canvas.interfaces

Interface AccountReader

All Superinterfaces:

CanvasReader<Account,AccountReader>

All Known Implementing Classes:

AccountImpl

public interface AccountReader
extends CanvasReader<Account,AccountReader>

Methods to read information from and about accounts

Method Summary

Modifier and Type	Method and Description
Optional<Account>	getSingleAccount(String accountId) Retrieve information on an individual account
List<Account>	getSubAccounts(GetSubAccountsOptions options) Return a list of sub-accounts to the given account
List<Account>	listAccounts(ListAccountOptions options) Return a list of accounts that the current user can view or manage.
List<Account>	listAccountsForCourseAdmins() List accounts that the current user can view through their admin course enrollments

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

getSingleAccount

Optional<Account> getSingleAccount(String accountId)
                            throws IOException

Retrieve information on an individual account

Parameters:

accountId - accountId Required. Account's id or sis_account_id

Returns:

The requested account from Canvas

Throws:

IOException - When there is an error communicating with Canvas

listAccounts

List<Account> listAccounts(ListAccountOptions options)
                    throws IOException

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

Parameters:

options - Object encapsulating parameters to the list accounts API call

Returns:

List of accounts

Throws:

IOException - When there is an error communicating with Canvas

getSubAccounts

List<Account> getSubAccounts(GetSubAccountsOptions options)
                      throws IOException

Return a list of sub-accounts to the given account

Parameters:

options - options object encapsulating parameters to the sub-accounts API call

Returns:

List of sub-accounts

Throws:

IOException - When there is an error communicating with Canvas

listAccountsForCourseAdmins

List<Account> listAccountsForCourseAdmins()
                                   throws IOException

List accounts that the current user can view through their admin course enrollments

Returns:

List of accounts

Throws:

IOException - When there is an error communicating with Canvas