edu.ksu.canvas.requestOptions

Class GetAssignmentGroupOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.GetAssignmentGroupOptions

public class GetAssignmentGroupOptions
extends BaseOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetAssignmentGroupOptions.Include

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
GetAssignmentGroupOptions(String courseId, Integer assignmentGroupId)

Method Summary

Modifier and Type	Method and Description
Integer	getAssignmentGroupId()
String	getCourseId()
GetAssignmentGroupOptions	gradingPeriodId(Integer periodId) Limit assignment groups to a grading period.
GetAssignmentGroupOptions	includes(List<GetAssignmentGroupOptions.Include> includes) Additional objects to include with the requested group.
GetAssignmentGroupOptions	overrideAssignmentDates(Boolean overrideDates) Whether or not to apply assignment overrides for each assignment.

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

GetAssignmentGroupOptions

public GetAssignmentGroupOptions(String courseId,
                                 Integer assignmentGroupId)

Method Detail

getCourseId

public String getCourseId()

getAssignmentGroupId

public Integer getAssignmentGroupId()

includes

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

Additional objects to include with the requested group. Note that all the optional includes depend on "assignments" also being included.

Parameters:

includes - List of included objects to return

Returns:

this object to continue building options

overrideAssignmentDates

public GetAssignmentGroupOptions overrideAssignmentDates(Boolean overrideDates)

Whether or not to apply assignment overrides for each assignment. Defaults to true.

Parameters:

overrideDates - Boolean indicating whether to apply assignment overrides

Returns:

this object to continue building options

gradingPeriodId

public GetAssignmentGroupOptions gradingPeriodId(Integer periodId)

Limit assignment groups to a grading period. Requires grading periods to exist at the account level

Parameters:

periodId - The ID of the grading period

Returns:

this object to continue building options