edu.ksu.canvas.requestOptions

Class GetSubmissionsOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.GetSubmissionsOptions

public class GetSubmissionsOptions
extends BaseOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetSubmissionsOptions.Include

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
GetSubmissionsOptions(String canvasId)
GetSubmissionsOptions(String canvasId, Integer assignmentId) Construct options class with required parameters to retrieve a list of Submissions from courses or sections
GetSubmissionsOptions(String canvasId, Integer assignmentId, String userId) Construct options class with required parameters to retrieve a single user's Submission from a course or section

Method Summary

Modifier and Type	Method and Description
Integer	getAssignmentId()
String	getCanvasId()
String	getUserId()
GetSubmissionsOptions	grouped(Boolean grouped) When set to true, response will be grouped by student groups.
GetSubmissionsOptions	includes(List<GetSubmissionsOptions.Include> includes) Optionally include more information with the returned assignment Submission objects.
void	setAssignmentId(Integer assignmentId)
void	setCanvasId(String canvasId)
void	setUserId(String userId)
GetSubmissionsOptions	userIds(List<String> userIds)

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

GetSubmissionsOptions

public GetSubmissionsOptions(String canvasId)

GetSubmissionsOptions

public GetSubmissionsOptions(String canvasId,
                             Integer assignmentId)

Construct options class with required parameters to retrieve a list of Submissions from courses or sections

Parameters:

canvasId - The Course or Section ID, depending on which API is being targeted. May also be an SIS ID with appropriate prefix

assignmentId - The Canvas ID of the assignment to query for submissions

GetSubmissionsOptions

public GetSubmissionsOptions(String canvasId,
                             Integer assignmentId,
                             String userId)

Construct options class with required parameters to retrieve a single user's Submission from a course or section

Parameters:

canvasId - The Course or Section ID, depending on which API is being targeted. May also be an SIS ID with appropriate prefix

assignmentId - The Canvas ID of the assignment to query for submissions

userId - The Canvas ID of the user to query (or SIS user ID with the appropriate prefix)

Method Detail

includes

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

Optionally include more information with the returned assignment Submission objects.

Parameters:

includes - List of optional includes

Returns:

This object to allow adding more options

grouped

public GetSubmissionsOptions grouped(Boolean grouped)

When set to true, response will be grouped by student groups. Only valid for Submission lists, not individual submission queries.

Parameters:

grouped - Whether to group submissions by student group

Returns:

This object to allow adding more options

userIds

public GetSubmissionsOptions userIds(List<String> userIds)

getCanvasId

public String getCanvasId()

setCanvasId

public void setCanvasId(String canvasId)

getAssignmentId

public Integer getAssignmentId()

setAssignmentId

public void setAssignmentId(Integer assignmentId)

getUserId

public String getUserId()

setUserId

public void setUserId(String userId)