edu.ksu.canvas.impl

Class AccountImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<Account,AccountReader,AccountWriter>

edu.ksu.canvas.impl.AccountImpl

All Implemented Interfaces:

AccountReader, AccountWriter, CanvasReader<Account,AccountReader>, CanvasWriter<Account,AccountWriter>

public class AccountImpl
extends BaseImpl<Account,AccountReader,AccountWriter>
implements AccountReader, AccountWriter

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

Method Summary

Modifier and Type	Method and Description
Optional<Account>	createAccount(String accountId, Account account) Create a new account in Canvas
Boolean	deleteAccount(String parentAccountId, String accountId)
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
protected Type	listType()
protected Class<Account>	objectType()
Optional<Account>	updateAccount(Account account) Update a account in Canvas

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

AccountImpl

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

Method Detail

getSingleAccount

public Optional<Account> getSingleAccount(String accountId)
                                   throws IOException

Description copied from interface: AccountReader

Retrieve information on an individual account

Specified by:

getSingleAccount in interface AccountReader

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

public List<Account> listAccounts(ListAccountOptions options)
                           throws IOException

Description copied from interface: AccountReader

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

Specified by:

listAccounts in interface AccountReader

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

public List<Account> getSubAccounts(GetSubAccountsOptions options)
                             throws IOException

Description copied from interface: AccountReader

Return a list of sub-accounts to the given account

Specified by:

getSubAccounts in interface AccountReader

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

public List<Account> listAccountsForCourseAdmins()
                                          throws IOException

Description copied from interface: AccountReader

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

Specified by:

listAccountsForCourseAdmins in interface AccountReader

Returns:

List of accounts

Throws:

IOException - When there is an error communicating with Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<Account,AccountReader,AccountWriter>

objectType

protected Class<Account> objectType()

Specified by:

objectType in class BaseImpl<Account,AccountReader,AccountWriter>

createAccount

public Optional<Account> createAccount(String accountId,
                                       Account account)
                                throws IOException

Description copied from interface: AccountWriter

Create a new account in Canvas

Specified by:

createAccount in interface AccountWriter

Parameters:

accountId - the account ID of the account under which to place this account

account - A account object containing the information needed to create a account in Canvas

Returns:

The newly created account

Throws:

IOException - When there is an error communicating with Canvas

updateAccount

public Optional<Account> updateAccount(Account account)
                                throws IOException

Description copied from interface: AccountWriter

Update a account in Canvas

Specified by:

updateAccount in interface AccountWriter

Parameters:

account - A account object containing the information needed to update a account in Canvas

Returns:

The newly updated account

Throws:

IOException - When there is an error communicating with Canvas

deleteAccount

public Boolean deleteAccount(String parentAccountId,
                             String accountId)
                      throws IOException

Specified by:

deleteAccount in interface AccountWriter

Parameters:

parentAccountId - The ID of the parent account to the account to delete.

accountId - The ID of the account you wish to delete

Returns:

true if the account was deleted

Throws:

IOException - When there is an error communicating with Canvas