edu.ksu.canvas.requestOptions

Class ListAssignmentGroupOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.ListAssignmentGroupOptions

public class ListAssignmentGroupOptions
extends BaseOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListAssignmentGroupOptions.ExcludeSubmissionTypes
static class	ListAssignmentGroupOptions.Include

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
ListAssignmentGroupOptions(String courseId)

Method Summary

Modifier and Type	Method and Description
ListAssignmentGroupOptions	excludeAssignmentSubmissionTypes(List<ListAssignmentGroupOptions.ExcludeSubmissionTypes> toExclude) If “assignments” are included, those with the specified submission types will be excluded from the assignment groups.
String	getCourseId()
ListAssignmentGroupOptions	gradingPeriodId(Integer periodId) The id of the grading period in which assignment groups are being requested (Requires grading periods to exist.)
ListAssignmentGroupOptions	includes(List<ListAssignmentGroupOptions.Include> includes) Associations to include with the group.
ListAssignmentGroupOptions	overrideAssignmentDates(Boolean overrideDates) Apply assignment overrides to the assignment, defaults to true.
ListAssignmentGroupOptions	scopeAssignmentsToStudent(Boolean scopeToStudent) If true, all assignments returned will apply to the current user in the specified grading period.

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

ListAssignmentGroupOptions

public ListAssignmentGroupOptions(String courseId)

Method Detail

getCourseId

public String getCourseId()

includes

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

Associations to include with the group. “discussion_topic”, “all_dates” “assignment_visibility” and “submission” are only valid if “assignments” is also included. The “assignment_visibility” option additionally 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

excludeAssignmentSubmissionTypes

public ListAssignmentGroupOptions excludeAssignmentSubmissionTypes(List<ListAssignmentGroupOptions.ExcludeSubmissionTypes> toExclude)

If “assignments” are included, those with the specified submission types will be excluded from the assignment groups.

Parameters:

toExclude - A list of the types of assignments that will be excluded.

Returns:

this to continue building options

overrideAssignmentDates

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

gradingPeriodId

public ListAssignmentGroupOptions gradingPeriodId(Integer periodId)

The id of the grading period in which assignment groups are being requested (Requires grading periods to exist.)

Parameters:

periodId - The ID of the appropriate period

Returns:

this to continue building options

scopeAssignmentsToStudent

public ListAssignmentGroupOptions scopeAssignmentsToStudent(Boolean scopeToStudent)

If true, all assignments returned will apply to the current user in the specified grading period. If assignments apply to other students in the specified grading period, but not the current user, they will not be returned. (Requires the grading_period_id argument and grading periods to exist. In addition, the current user must be a student.)

Parameters:

scopeToStudent - Whether or not all assignments will apply to the current user in the specified grading period.

Returns:

this to continue building options