edu.ksu.canvas.requestOptions

Class ListActiveCoursesInAccountOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.ListActiveCoursesInAccountOptions

public class ListActiveCoursesInAccountOptions
extends BaseOptions

A class to represent parameters to be passed to the "List active courses in account" API call. See https://canvas.instructure.com/doc/api/accounts.html#method.accounts.courses_api

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListActiveCoursesInAccountOptions.EnrollmentType
static class	ListActiveCoursesInAccountOptions.Include
static class	ListActiveCoursesInAccountOptions.SearchBy
static class	ListActiveCoursesInAccountOptions.State

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
ListActiveCoursesInAccountOptions(String accountId)

Method Summary

Modifier and Type	Method and Description
ListActiveCoursesInAccountOptions	addEnrollmentTermId(String enrollmentTermId) Only include courses in the specified enrollment term
String	getAccountId()
ListActiveCoursesInAccountOptions	includes(List<ListActiveCoursesInAccountOptions.Include> includes) Optional elements to include in the returned courses.
ListActiveCoursesInAccountOptions	inState(List<ListActiveCoursesInAccountOptions.State> stateList) Only include courses that are in the given list of states.
ListActiveCoursesInAccountOptions	inSubaccount(List<String> accountList) Only include courses in sub-accounts identified by the given list of account IDs
ListActiveCoursesInAccountOptions	onlyBlueprint(Boolean blueprint) If true, include only blueprint courses.
ListActiveCoursesInAccountOptions	onlyBlueprintAssociated(Boolean blueprintAssociated) If true, include only courses that inherit content from a blueprint course.
ListActiveCoursesInAccountOptions	onlyCompleted(Boolean completed) If true, include only completed courses (these may be in state 'completed', or their enrollment term may have ended).
ListActiveCoursesInAccountOptions	onlyPublished(Boolean published) If true, include only published courses.
ListActiveCoursesInAccountOptions	searchBy(ListActiveCoursesInAccountOptions.SearchBy searchType)
ListActiveCoursesInAccountOptions	searchTerm(String searchTerm) Filter on a search term.
ListActiveCoursesInAccountOptions	taughtByTeachers(List<String> teacherList) Only include courses taught by the given list of teacher user IDs
ListActiveCoursesInAccountOptions	withEnrollments(Boolean enrollments) If true, include only courses with at least one enrollment.
ListActiveCoursesInAccountOptions	withEnrollmentTypes(List<ListActiveCoursesInAccountOptions.EnrollmentType> enrollmentTypes) If set, only return courses that have at least one user enrolled in in the course with one of the specified enrollment types.

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

ListActiveCoursesInAccountOptions

public ListActiveCoursesInAccountOptions(String accountId)

Method Detail

getAccountId

public String getAccountId()

withEnrollments

public ListActiveCoursesInAccountOptions withEnrollments(Boolean enrollments)

If true, include only courses with at least one enrollment. If false, include only courses with no enrollments. If not present, do not filter on course enrollment status.

Parameters:

enrollments - Whether to filter course list on enrollment status

Returns:

This object to allow adding more options

withEnrollmentTypes

public ListActiveCoursesInAccountOptions withEnrollmentTypes(List<ListActiveCoursesInAccountOptions.EnrollmentType> enrollmentTypes)

If set, only return courses that have at least one user enrolled in in the course with one of the specified enrollment types.

Parameters:

enrollmentTypes - List of enrollment types to filter on

Returns:

This object to allow adding more options

onlyPublished

public ListActiveCoursesInAccountOptions onlyPublished(Boolean published)

If true, include only published courses. If false, exclude published courses. If not present, do not filter on published status.

Parameters:

published - Published status to filter on

Returns:

This object to allow adding more options

onlyBlueprint

public ListActiveCoursesInAccountOptions onlyBlueprint(Boolean blueprint)

If true, include only blueprint courses. If false, exclude blueprint courses. If not present, do not filter on blueprint status.

Parameters:

blueprint - Blueprint status to filter on

Returns:

This object to allow adding more options

onlyBlueprintAssociated

public ListActiveCoursesInAccountOptions onlyBlueprintAssociated(Boolean blueprintAssociated)

If true, include only courses that inherit content from a blueprint course. If false, exclude them. If not present, do not filter on this basis.

Parameters:

blueprintAssociated - Blueprint association filter value

Returns:

This object to allow adding more options

onlyCompleted

public ListActiveCoursesInAccountOptions onlyCompleted(Boolean completed)

If true, include only completed courses (these may be in state 'completed', or their enrollment term may have ended). If false, exclude completed courses. If not present, do not filter on completed status.

Parameters:

completed - Completed status to filter on

Returns:

This object to allow adding more options

taughtByTeachers

public ListActiveCoursesInAccountOptions taughtByTeachers(List<String> teacherList)

Only include courses taught by the given list of teacher user IDs

Parameters:

teacherList - List of teacher user IDs to filter on (can "be sis_user_id:xxxx")

Returns:

This object to allow adding more options

inSubaccount

public ListActiveCoursesInAccountOptions inSubaccount(List<String> accountList)

Only include courses in sub-accounts identified by the given list of account IDs

Parameters:

accountList - List of sub-account IDs (can be "sis_account_id:xxxx")

Returns:

This object to allow adding more options

inState

public ListActiveCoursesInAccountOptions inState(List<ListActiveCoursesInAccountOptions.State> stateList)

Only include courses that are in the given list of states. By default all states but "deleted" are returned.

Parameters:

stateList - List of states to filter by

Returns:

This object to allow adding more options

addEnrollmentTermId

public ListActiveCoursesInAccountOptions addEnrollmentTermId(String enrollmentTermId)

Only include courses in the specified enrollment term

Parameters:

enrollmentTermId - Term ID to filter by (can be "sis_term_id:xxxxx")

Returns:

This object to allow adding more options

searchTerm

public ListActiveCoursesInAccountOptions searchTerm(String searchTerm)

Filter on a search term. Can be course name, code or full ID. Must be at least 3 characters

Parameters:

searchTerm - Search term to filter by

Returns:

This object to allow adding more options

includes

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

Optional elements to include in the returned courses. “sections”, “needs_grading_count” and “total_scores” are not valid options at the account level

Parameters:

includes - List of optional elements

Returns:

This object to allow adding more options

searchBy

public ListActiveCoursesInAccountOptions searchBy(ListActiveCoursesInAccountOptions.SearchBy searchType)