edu.ksu.canvas.requestOptions

Class GetUsersInAccountOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.GetUsersInAccountOptions

public class GetUsersInAccountOptions
extends BaseOptions

Options class which supports queries used to retrieve all users for a given account.

Standard information which can be queried upon include:

• A search term - which behaves analogously to the browser search in what it accepts and searches on
• The column with which to sort by - username, email, sis_id and login are acceptable options
• The overall ordering cardinality of the data brought back

A commonplace query parameter is also added for querying convenience:
include[] - useful to include extra values that are not included in the data objects by default. Acceptable values are avatar_url, email, last_login and time_zone.

The values which are supported with this are found on the "List users in account" portion of the Canvas API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetUsersInAccountOptions.Include

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
GetUsersInAccountOptions(String accountId)

Method Summary

Modifier and Type	Method and Description
String	getAccountId()
GetUsersInAccountOptions	include(List<GetUsersInAccountOptions.Include> includes)
GetUsersInAccountOptions	order(String order)
GetUsersInAccountOptions	searchTerm(String searchTerm)
GetUsersInAccountOptions	sort(String sort)

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

GetUsersInAccountOptions

public GetUsersInAccountOptions(String accountId)

Method Detail

getAccountId

public String getAccountId()

searchTerm

public GetUsersInAccountOptions searchTerm(String searchTerm)

sort

public GetUsersInAccountOptions sort(String sort)

order

public GetUsersInAccountOptions order(String order)

include

public GetUsersInAccountOptions include(List<GetUsersInAccountOptions.Include> includes)