edu.ksu.canvas.requestOptions

Class GetUsersInCourseOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.GetUsersInCourseOptions

public class GetUsersInCourseOptions
extends BaseOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetUsersInCourseOptions.EnrollmentState
static class	GetUsersInCourseOptions.EnrollmentType
static class	GetUsersInCourseOptions.Include

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
GetUsersInCourseOptions(String courseId)

Method Summary

Modifier and Type	Method and Description
GetUsersInCourseOptions	enrollmentRoleId(Integer roleId) Filter users by course-level role ID.
GetUsersInCourseOptions	enrollmentState(List<GetUsersInCourseOptions.EnrollmentState> enrollmentStates) Filter users by enrollment state
GetUsersInCourseOptions	enrollmentType(List<GetUsersInCourseOptions.EnrollmentType> enrollmentTypes) Only return users who match the given enrollment type.
String	getCourseId()
GetUsersInCourseOptions	include(List<GetUsersInCourseOptions.Include> includes) Optional sub-items to include in the user response
GetUsersInCourseOptions	searchTerm(String searchTerm) Only return users who match search term.
GetUsersInCourseOptions	userId(String userId) If the given user ID exists in a course, the page parameter will be modified to return the page containing the given user.
GetUsersInCourseOptions	userIds(List<String> userIds) Only return the users in the given list of user IDs

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

GetUsersInCourseOptions

public GetUsersInCourseOptions(String courseId)

Method Detail

getCourseId

public String getCourseId()

searchTerm

public GetUsersInCourseOptions searchTerm(String searchTerm)

Only return users who match search term. Can be a partial name or a full ID

Parameters:

searchTerm - Search term to filter users by

Returns:

This object to allow adding more options

enrollmentType

public GetUsersInCourseOptions enrollmentType(List<GetUsersInCourseOptions.EnrollmentType> enrollmentTypes)

Only return users who match the given enrollment type. Ignored if enrollmentRole is used.

Parameters:

enrollmentTypes - List of enrollment types to include

Returns:

This object to allow adding more options

enrollmentRoleId

public GetUsersInCourseOptions enrollmentRoleId(Integer roleId)

Filter users by course-level role ID. This can be a custom role created via the Role API or a built in role

Parameters:

roleId - ID of the role to filter users by

Returns:

This object to allow adding more options

include

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

Optional sub-items to include in the user response

Parameters:

includes - List of includes to request

Returns:

This object to allow adding more options

userId

public GetUsersInCourseOptions userId(String userId)

If the given user ID exists in a course, the page parameter will be modified to return the page containing the given user.

Parameters:

userId - User ID to page to

Returns:

This object to allow adding more options

userIds

public GetUsersInCourseOptions userIds(List<String> userIds)

Only return the users in the given list of user IDs

Parameters:

userIds - List of user IDs to return

Returns:

This object to allow adding more options

enrollmentState

public GetUsersInCourseOptions enrollmentState(List<GetUsersInCourseOptions.EnrollmentState> enrollmentStates)

Filter users by enrollment state

Parameters:

enrollmentStates - List of enrollment states to filter users by

Returns:

This object to allow adding more options