edu.ksu.canvas.requestOptions

Class ListExternalToolsOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.ListExternalToolsOptions

public class ListExternalToolsOptions
extends BaseOptions

Field Summary

Fields inherited from class edu.ksu.canvas.requestOptions.BaseOptions

optionsMap

Constructor Summary

Constructors

Constructor and Description
ListExternalToolsOptions(String id)

Method Summary

Modifier and Type	Method and Description
String	getId()
ListExternalToolsOptions	includeParentTools(Boolean includeParents) If true, include tools installed in all accounts above the current context.
ListExternalToolsOptions	isSelectable(Boolean selectable) If true, only tools that are meant to be selectable are returned
ListExternalToolsOptions	searchTerm(String searchTerm) Only return tools with a name matching this partial string

Methods inherited from class edu.ksu.canvas.requestOptions.BaseOptions

addEnumList, addNumberList, addSingleItem, addStringList, getOptionsMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListExternalToolsOptions

public ListExternalToolsOptions(String id)

Method Detail

getId

public String getId()

searchTerm

public ListExternalToolsOptions searchTerm(String searchTerm)

Only return tools with a name matching this partial string

Parameters:

searchTerm - Tool name to search for

Returns:

This object to allow adding more options

isSelectable

public ListExternalToolsOptions isSelectable(Boolean selectable)

If true, only tools that are meant to be selectable are returned

Parameters:

selectable - Whether to filter tools by selectability

Returns:

This object to allow adding more options

includeParentTools

public ListExternalToolsOptions includeParentTools(Boolean includeParents)

If true, include tools installed in all accounts above the current context.

This will give you ALL the tools available in the specified course/group/account even if they were installed in a parent account.

Parameters:

includeParents - True to include tools from parent accounts

Returns:

This object to allow adding more options