Uses of Class
edu.ksu.canvas.requestOptions.GetEnrollmentOptions

Packages that use GetEnrollmentOptions

Package	Description
edu.ksu.canvas.impl	Default implementations for Canvas API calls.
edu.ksu.canvas.interfaces	Interfaces defining Canvas API functionality
edu.ksu.canvas.requestOptions	Classes to encapsulate parameters that get passed to API calls.

Uses of GetEnrollmentOptions in edu.ksu.canvas.impl

Methods in edu.ksu.canvas.impl with parameters of type GetEnrollmentOptions

Modifier and Type	Method and Description
List<Enrollment>	EnrollmentImpl.getCourseEnrollments(GetEnrollmentOptions options)
List<Enrollment>	EnrollmentImpl.getSectionEnrollments(GetEnrollmentOptions options)
List<Enrollment>	EnrollmentImpl.getUserEnrollments(GetEnrollmentOptions options)

Uses of GetEnrollmentOptions in edu.ksu.canvas.interfaces

Methods in edu.ksu.canvas.interfaces with parameters of type GetEnrollmentOptions

Modifier and Type	Method and Description
List<Enrollment>	EnrollmentReader.getCourseEnrollments(GetEnrollmentOptions options) Retrieve enrollments in a given course.
List<Enrollment>	EnrollmentReader.getSectionEnrollments(GetEnrollmentOptions options) Retrieve enrollments in a given section.
List<Enrollment>	EnrollmentReader.getUserEnrollments(GetEnrollmentOptions options) Retrieve a user's enrollments.

Uses of GetEnrollmentOptions in edu.ksu.canvas.requestOptions

Methods in edu.ksu.canvas.requestOptions that return GetEnrollmentOptions

Modifier and Type	Method and Description
GetEnrollmentOptions	GetEnrollmentOptions.gradingPeriodId(Integer gradingPeriod) Return grades for the given grading period.
GetEnrollmentOptions	GetEnrollmentOptions.include(List<GetEnrollmentOptions.Include> includes) Additional objects to include in the returned enrollments.
GetEnrollmentOptions	GetEnrollmentOptions.role(List<String> roles) Filter the list of enrollments by the given enrollment roles.
GetEnrollmentOptions	GetEnrollmentOptions.sisAccountId(List<String> sisAccountIds) Only return enrollments for the specified SIS account IDs.
GetEnrollmentOptions	GetEnrollmentOptions.sisCourseId(List<String> sisCourseIds) Only return enrollments for the specified SIS course IDs.
GetEnrollmentOptions	GetEnrollmentOptions.sisSectionId(List<String> sisSectionIds) Only return enrollments for the specified SIS section IDs.
GetEnrollmentOptions	GetEnrollmentOptions.sisUserId(List<String> sisUserIds) Only return enrollments for the specified SIS user IDs.
GetEnrollmentOptions	GetEnrollmentOptions.state(List<GetEnrollmentOptions.EnrollmentState> enrollmentStates) Filter the list of enrollments by the given enrollment states.
GetEnrollmentOptions	GetEnrollmentOptions.type(List<GetEnrollmentOptions.EnrollmentType> enrollmentTypes) Specify enrollment types to filter the returned list by (student, teacher, TA, designer, observer) This option is ignored if a role is specified.
GetEnrollmentOptions	GetEnrollmentOptions.userId(String userId) Filter by the given user ID.