edu.ksu.canvas.interfaces

Interface ExternalToolReader

All Superinterfaces:

CanvasReader<ExternalTool,ExternalToolReader>

All Known Implementing Classes:

ExternalToolImpl

public interface ExternalToolReader
extends CanvasReader<ExternalTool,ExternalToolReader>

Method Summary

Modifier and Type	Method and Description
Optional<ExternalTool>	getExternalToolInAccount(String accountId, Integer toolId) Retrieve a specific external tool configuration in a given account
Optional<ExternalTool>	getExternalToolInCourse(String courseId, Integer toolId) Retrieve a specific external tool configuration in a given course
List<ExternalTool>	listExternalToolsInAccount(ListExternalToolsOptions options) Return a list of external tools registered to an account
List<ExternalTool>	listExternalToolsInCourse(ListExternalToolsOptions options) Return a list of external tools registered to a course
List<ExternalTool>	listExternalToolsInGroup(ListExternalToolsOptions options) Return a list of external tools registered to a group

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

getExternalToolInAccount

Optional<ExternalTool> getExternalToolInAccount(String accountId,
                                                Integer toolId)
                                         throws IOException

Retrieve a specific external tool configuration in a given account

Parameters:

accountId - The Canvas ID or sis_account_id:[SIS ID] for the account to query

toolId - The Canvas ID of the tool to query

Returns:

The requested tool's configuration

Throws:

IOException - if there is an error communicating with Canvas

getExternalToolInCourse

Optional<ExternalTool> getExternalToolInCourse(String courseId,
                                               Integer toolId)
                                        throws IOException

Retrieve a specific external tool configuration in a given course

Parameters:

courseId - The Canvas ID or sis_course_id:[SIS ID] for the course to query

toolId - The Canvas ID of the tool to query

Returns:

The requested tool's configuration

Throws:

IOException - if there is an error communicating with Canvas

listExternalToolsInAccount

List<ExternalTool> listExternalToolsInAccount(ListExternalToolsOptions options)
                                       throws IOException

Return a list of external tools registered to an account

Parameters:

options - Parameters that alter which tools are returned by this call

Returns:

List of external tools in the account

Throws:

IOException - if there is an error communicating with Canvas

listExternalToolsInCourse

List<ExternalTool> listExternalToolsInCourse(ListExternalToolsOptions options)
                                      throws IOException

Return a list of external tools registered to a course

Parameters:

options - Parameters that alter which tools are returned by this call

Returns:

List of external tools in the course

Throws:

IOException - if there is an error communicating with Canvas

listExternalToolsInGroup

List<ExternalTool> listExternalToolsInGroup(ListExternalToolsOptions options)
                                     throws IOException

Return a list of external tools registered to a group

Parameters:

options - Parameters that alter which tools are returned by this call

Returns:

List of external tools in the group

Throws:

IOException - if there is an error communicating with Canvas