edu.ksu.canvas.interfaces

Interface AccountWriter

All Superinterfaces:

CanvasWriter<Account,AccountWriter>

All Known Implementing Classes:

AccountImpl

public interface AccountWriter
extends CanvasWriter<Account,AccountWriter>

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>	updateAccount(Account account) Update a account in Canvas

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

writeAsCanvasUser, writeAsSisUser

Method Detail

createAccount

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

Create a new account in Canvas

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

Optional<Account> updateAccount(Account account)
                         throws IOException

Update a account in Canvas

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

Boolean deleteAccount(String parentAccountId,
                      String accountId)
               throws IOException

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