edu.ksu.canvas.requestOptions

Class ListCourseAssignmentsOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.ListCourseAssignmentsOptions

Direct Known Subclasses:

ListUserAssignmentOptions

public class ListCourseAssignmentsOptions
extends BaseOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListCourseAssignmentsOptions.Bucket
static class	ListCourseAssignmentsOptions.Include

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
ListCourseAssignmentsOptions(String courseId)

Method Summary

Modifier and Type	Method and Description
ListCourseAssignmentsOptions	bucketFilter(ListCourseAssignmentsOptions.Bucket bucket) Only return assignments that match the due date and submission status of the given bucket
String	getCourseId()
ListCourseAssignmentsOptions	includes(List<ListCourseAssignmentsOptions.Include> includes) Associations to include with the assignment.
ListCourseAssignmentsOptions	needsGradingCountBySection(Boolean gradingCountBySection) Specify whether or not to split up the "needs grading count" by sections into the "needs_grading_count_by_section key.
ListCourseAssignmentsOptions	overrideAssignmentDates(Boolean overrideDates) Apply assignment overrides to the assignment, defaults to true.
ListCourseAssignmentsOptions	searchTerm(String searchTerm) Restrict results to partial matches in the assignment title

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

ListCourseAssignmentsOptions

public ListCourseAssignmentsOptions(String courseId)

Method Detail

getCourseId

public String getCourseId()

includes

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

Associations to include with the assignment. The “assignment_visibility” option requires that the Differentiated Assignments course feature be turned on.

Parameters:

includes - List of optional associations to include in the assignment request

Returns:

this to continue building options

searchTerm

public ListCourseAssignmentsOptions searchTerm(String searchTerm)

Restrict results to partial matches in the assignment title

Parameters:

searchTerm - Search term to match

Returns:

this to continue building options

overrideAssignmentDates

public ListCourseAssignmentsOptions overrideAssignmentDates(Boolean overrideDates)

Apply assignment overrides to the assignment, defaults to true.

Parameters:

overrideDates - Whether or not to apply override

Returns:

this to continue building options

needsGradingCountBySection

public ListCourseAssignmentsOptions needsGradingCountBySection(Boolean gradingCountBySection)

Specify whether or not to split up the "needs grading count" by sections into the "needs_grading_count_by_section key. Defaults to false.

Parameters:

gradingCountBySection - Whether or not to split up needs_grading_count by section

Returns:

this to continue building options

bucketFilter

public ListCourseAssignmentsOptions bucketFilter(ListCourseAssignmentsOptions.Bucket bucket)

Only return assignments that match the due date and submission status of the given bucket

Parameters:

bucket - Status bucket to filter assignments by

Returns:

this to continue building options