edu.ksu.canvas.requestOptions

Class ListUserCoursesOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.ListUserCoursesOptions

public class ListUserCoursesOptions
extends BaseOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListUserCoursesOptions.EnrollmentState
static class	ListUserCoursesOptions.Include
static class	ListUserCoursesOptions.State

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
ListUserCoursesOptions(String userId) Constructor with required userId

Method Summary

Modifier and Type	Method and Description
ListUserCoursesOptions	enrollmentStates(ListUserCoursesOptions.EnrollmentState enrollmentState) If set, only return courses that are in the given enrollment state
String	getUserId()
ListUserCoursesOptions	includes(List<ListUserCoursesOptions.Include> includes) Include additional optional fields in the course objects
ListUserCoursesOptions	states(List<ListUserCoursesOptions.State> states) If set, only return courses that are in the given state(s)

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

ListUserCoursesOptions

public ListUserCoursesOptions(String userId)

Constructor with required userId

Parameters:

userId - can be the canvasUserId or sis_login_id:loginName

Method Detail

getUserId

public String getUserId()

includes

public ListUserCoursesOptions includes(List<ListUserCoursesOptions.Include> includes)

Include additional optional fields in the course objects

Parameters:

includes - List of additional fields to include

Returns:

This object to allow adding more options

states

public ListUserCoursesOptions states(List<ListUserCoursesOptions.State> states)

If set, only return courses that are in the given state(s)

Parameters:

states - A list of states to filter on

Returns:

This object to allow adding more options

enrollmentStates

public ListUserCoursesOptions enrollmentStates(ListUserCoursesOptions.EnrollmentState enrollmentState)

If set, only return courses that are in the given enrollment state

Parameters:

enrollmentState - A list of states to filter on

Returns:

This object to allow adding more options