edu.ksu.canvas.requestOptions

Class GetSingleAssignmentOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.GetSingleAssignmentOptions

public class GetSingleAssignmentOptions
extends BaseOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetSingleAssignmentOptions.Include

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
GetSingleAssignmentOptions(String courseId, Integer assignmentId)

Method Summary

Modifier and Type	Method and Description
GetSingleAssignmentOptions	allDates(Boolean allDates) Specify if all dates associated with the assignment should be returned, if applicable
Integer	getAssignmentId()
String	getCourseId()
GetSingleAssignmentOptions	includes(List<GetSingleAssignmentOptions.Include> includes) Associations to include with the assignment.
GetSingleAssignmentOptions	needsGradingCountBySection(Boolean gradingCountBySection) Specify whether or not to split up the "needs grading count" by sections into the "needs_grading_count_by_section key.
GetSingleAssignmentOptions	overrideAssignmentDates(Boolean overrideDates) Apply assignment overrides to the assignment, defaults to true.

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

GetSingleAssignmentOptions

public GetSingleAssignmentOptions(String courseId,
                                  Integer assignmentId)

Method Detail

getCourseId

public String getCourseId()

getAssignmentId

public Integer getAssignmentId()

includes

public GetSingleAssignmentOptions includes(List<GetSingleAssignmentOptions.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

overrideAssignmentDates

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

allDates

public GetSingleAssignmentOptions allDates(Boolean allDates)

Specify if all dates associated with the assignment should be returned, if applicable

Parameters:

allDates - If all dates should be returned

Returns:

this to continue building options