edu.ksu.canvas.interfaces

Interface LoginWriter

All Superinterfaces:

CanvasWriter<Login,LoginWriter>

All Known Implementing Classes:

LoginImpl

public interface LoginWriter
extends CanvasWriter<Login,LoginWriter>

Method Summary

Modifier and Type	Method and Description
Optional<Login>	deleteLogin(Login login) Delete a login from Canvas
Optional<Login>	updateLogin(Login login) Write changes to a login to Canvas.

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

writeAsCanvasUser, writeAsSisUser

Method Detail

updateLogin

Optional<Login> updateLogin(Login login)
                     throws IOException

Write changes to a login to Canvas.

Parameters:

login - The modified login to update. Must contain account ID and login ID.

Returns:

The modified login object if update was successful

Throws:

IOException - When there is an error communicating with Canvas

deleteLogin

Optional<Login> deleteLogin(Login login)
                     throws IOException

Delete a login from Canvas

Parameters:

login - The login record to delete. Must contain User ID and login ID.

Returns:

The now deleted login record

Throws:

IOException - When there is an error communicating with Canvas