edu.ksu.canvas.requestOptions

Class ListRolesOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.ListRolesOptions

public class ListRolesOptions
extends BaseOptions

A class to represent parameters to be passed to the "List the roles available to an account" API call. See https://canvas.instructure.com/doc/api/roles.html#method.role_overrides.api_index

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListRolesOptions.State

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
ListRolesOptions(String accountId)

Method Summary

Modifier and Type	Method and Description
String	getAccountId()
ListRolesOptions	showInherited(Boolean show) If set to true, inherited roles from parent accounts will be included
ListRolesOptions	state(List<ListRolesOptions.State> states) Filter returned roles by activity state.

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

ListRolesOptions

public ListRolesOptions(String accountId)

Method Detail

getAccountId

public String getAccountId()

showInherited

public ListRolesOptions showInherited(Boolean show)

If set to true, inherited roles from parent accounts will be included

Parameters:

show - Whether or not to include inherited roles

Returns:

This object to allow adding more options

state

public ListRolesOptions state(List<ListRolesOptions.State> states)

Filter returned roles by activity state. Default is only "active" roles

Parameters:

states - List of states to filter by (active or inactive)

Returns:

This object to allow adding more options