edu.ksu.canvas.requestOptions

Class GetEnrollmentOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.GetEnrollmentOptions

public class GetEnrollmentOptions
extends BaseOptions

Nested Class Summary

Nested Classes

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

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
GetEnrollmentOptions(String objectId) Constructs object to hold API options for the enrollment retriever calls.

Method Summary

Modifier and Type	Method and Description
String	getObjectId()
GetEnrollmentOptions	gradingPeriodId(Integer gradingPeriod) Return grades for the given grading period.
GetEnrollmentOptions	include(List<GetEnrollmentOptions.Include> includes) Additional objects to include in the returned enrollments.
GetEnrollmentOptions	role(List<String> roles) Filter the list of enrollments by the given enrollment roles.
GetEnrollmentOptions	sisAccountId(List<String> sisAccountIds) Only return enrollments for the specified SIS account IDs.
GetEnrollmentOptions	sisCourseId(List<String> sisCourseIds) Only return enrollments for the specified SIS course IDs.
GetEnrollmentOptions	sisSectionId(List<String> sisSectionIds) Only return enrollments for the specified SIS section IDs.
GetEnrollmentOptions	sisUserId(List<String> sisUserIds) Only return enrollments for the specified SIS user IDs.
GetEnrollmentOptions	state(List<GetEnrollmentOptions.EnrollmentState> enrollmentStates) Filter the list of enrollments by the given enrollment states.
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	userId(String userId) Filter by the given user ID.

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

GetEnrollmentOptions

public GetEnrollmentOptions(String objectId)

Constructs object to hold API options for the enrollment retriever calls. Courses, sections and users all have an identical API call that all use this object.

Parameters:

objectId - The course, section or user ID, depending on which API call you are hitting

Method Detail

getObjectId

public String getObjectId()

type

public 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.

Parameters:

enrollmentTypes - All the enrollment types you want to retrieve

Returns:

This object to allow adding more options

role

public GetEnrollmentOptions role(List<String> roles)

Filter the list of enrollments by the given enrollment roles. Accepted values are the same as the base enrollment types in the "type" parameter and any custom roles created via the Roles API.

Parameters:

roles - List of roles to filter enrollments by

Returns:

This object to allow adding more options

state

public GetEnrollmentOptions state(List<GetEnrollmentOptions.EnrollmentState> enrollmentStates)

Filter the list of enrollments by the given enrollment states. Defaults to "active" and "invited"

Parameters:

enrollmentStates - List of enrollment states to filter on

Returns:

This object to allow adding more options

include

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

Additional objects to include in the returned enrollments. Avatar URL and group IDs will be returned on the user record

Parameters:

includes - List of additional items to include

Returns:

This object to allow adding more options

userId

public GetEnrollmentOptions userId(String userId)

Filter by the given user ID. Only valid on course or section enrollment queries. If set to the current user's id, this is a way to determine if the user has any enrollments in the course or section, independent of whether the user has permission to view other people on the roster.

Parameters:

userId - User ID to filter enrollments by

Returns:

This object to allow adding more options

gradingPeriodId

public GetEnrollmentOptions gradingPeriodId(Integer gradingPeriod)

Return grades for the given grading period. If not set, grades will be for the entire course.

Parameters:

gradingPeriod - Grading period to restrict reported grades to

Returns:

This object to allow adding more options

sisAccountId

public GetEnrollmentOptions sisAccountId(List<String> sisAccountIds)

Only return enrollments for the specified SIS account IDs. Does not recurse into sub-accounts.

Parameters:

sisAccountIds - SIS account Ids

Returns:

This object to allow adding more options

sisCourseId

public GetEnrollmentOptions sisCourseId(List<String> sisCourseIds)

Only return enrollments for the specified SIS course IDs.

Parameters:

sisCourseIds - SIS course Ids

Returns:

This object to allow adding more options

sisSectionId

public GetEnrollmentOptions sisSectionId(List<String> sisSectionIds)

Only return enrollments for the specified SIS section IDs.

Parameters:

sisSectionIds - SIS section IDs

Returns:

This object to allow adding more options

sisUserId

public GetEnrollmentOptions sisUserId(List<String> sisUserIds)

Only return enrollments for the specified SIS user IDs.

Parameters:

sisUserIds - SIS user Ids

Returns:

This object to allow adding more options