edu.ksu.canvas.impl

Class AssignmentGroupImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<AssignmentGroup,AssignmentGroupReader,AssignmentGroupWriter>

edu.ksu.canvas.impl.AssignmentGroupImpl

All Implemented Interfaces:

AssignmentGroupReader, AssignmentGroupWriter, CanvasReader<AssignmentGroup,AssignmentGroupReader>, CanvasWriter<AssignmentGroup,AssignmentGroupWriter>

public class AssignmentGroupImpl
extends BaseImpl<AssignmentGroup,AssignmentGroupReader,AssignmentGroupWriter>
implements AssignmentGroupReader, AssignmentGroupWriter

Field Summary

Fields inherited from class edu.ksu.canvas.impl.BaseImpl

apiVersion, canvasBaseUrl, canvasMessenger, masqueradeAs, masqueradeType, oauthToken, paginationPageSize, responseCallback, responseParser, serializeNulls

Constructor Summary

Constructors

Constructor and Description
AssignmentGroupImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls) Construct a new CanvasApi class with an OAuth token

Method Summary

Modifier and Type	Method and Description
Optional<AssignmentGroup>	createAssignmentGroup(String courseId, AssignmentGroup assignmentGroup) Creates an assignment group in Canvas.
Optional<AssignmentGroup>	deleteAssignmentGroup(DeleteAssignmentGroupOptions options) Delete an assignment group from Canvas.
Optional<AssignmentGroup>	editAssignmentGroup(String courseId, AssignmentGroup assignmentGroup) Modify an existing assignment group in Canvas.
Optional<AssignmentGroup>	getAssignmentGroup(GetAssignmentGroupOptions options) Returns the requested assignment group by ID
List<AssignmentGroup>	listAssignmentGroup(ListAssignmentGroupOptions options) Return a list of AssignmentGroups that the current user can view or manage.
protected Type	listType()
protected Class<AssignmentGroup>	objectType()

Methods inherited from class edu.ksu.canvas.impl.BaseImpl

buildCanvasUrl, encode, getFromCanvas, getListFromCanvas, parseListOfResponses, readAsCanvasUser, readAsSisUser, withCallback, writeAsCanvasUser, writeAsSisUser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface edu.ksu.canvas.interfaces.CanvasReader

readAsCanvasUser, readAsSisUser, withCallback

Methods inherited from interface edu.ksu.canvas.interfaces.CanvasWriter

writeAsCanvasUser, writeAsSisUser

Constructor Detail

AssignmentGroupImpl

public AssignmentGroupImpl(String canvasBaseUrl,
                           Integer apiVersion,
                           OauthToken oauthToken,
                           RestClient restClient,
                           int connectTimeout,
                           int readTimeout,
                           Integer paginationPageSize,
                           Boolean serializeNulls)

Construct a new CanvasApi class with an OAuth token

Parameters:

canvasBaseUrl - The base URL of your canvas instance

apiVersion - The version of the Canvas API (currently 1)

oauthToken - OAuth token to use when executing API calls

restClient - a RestClient implementation to use when talking to Canvas

connectTimeout - Timeout in seconds to use when connecting

readTimeout - Timeout in seconds to use when waiting for data to come back from an open connection

paginationPageSize - How many objects to request per page on paginated requests

serializeNulls - Whether or not to include null fields in the serialized JSON. Defaults to false if null

Method Detail

getAssignmentGroup

public Optional<AssignmentGroup> getAssignmentGroup(GetAssignmentGroupOptions options)
                                             throws IOException

Description copied from interface: AssignmentGroupReader

Returns the requested assignment group by ID

Specified by:

getAssignmentGroup in interface AssignmentGroupReader

Parameters:

options - Collection of optional parameters to the Canvas API

Returns:

The requested assignment group

Throws:

IOException - When there is an error communicating with Canvas

listAssignmentGroup

public List<AssignmentGroup> listAssignmentGroup(ListAssignmentGroupOptions options)
                                          throws IOException

Description copied from interface: AssignmentGroupReader

Return a list of AssignmentGroups that the current user can view or manage.

Specified by:

listAssignmentGroup in interface AssignmentGroupReader

Parameters:

options - A mapping of optional parameters for assignment groups

Returns:

List of AssignmentGroups

Throws:

IOException - When there is an error communicating with Canvas

createAssignmentGroup

public Optional<AssignmentGroup> createAssignmentGroup(String courseId,
                                                       AssignmentGroup assignmentGroup)
                                                throws IOException

Description copied from interface: AssignmentGroupWriter

Creates an assignment group in Canvas.

Specified by:

createAssignmentGroup in interface AssignmentGroupWriter

Parameters:

courseId - Course that the assignment group is in

assignmentGroup - The Assignment Group object to create

Returns:

AssignmentGroup object created in Canvas

Throws:

IOException - When there is an error communicating with Canvas

editAssignmentGroup

public Optional<AssignmentGroup> editAssignmentGroup(String courseId,
                                                     AssignmentGroup assignmentGroup)
                                              throws IOException

Description copied from interface: AssignmentGroupWriter

Modify an existing assignment group in Canvas. It must have an ID assigned by Canvas.

Specified by:

editAssignmentGroup in interface AssignmentGroupWriter

Parameters:

courseId - Course ID of the course containing the assignment group to edit

assignmentGroup - Modified assignment group to save

Returns:

Modified assignment group from Canvas

Throws:

IOException - When there is an error communicating with Canvas

deleteAssignmentGroup

public Optional<AssignmentGroup> deleteAssignmentGroup(DeleteAssignmentGroupOptions options)
                                                throws IOException

Description copied from interface: AssignmentGroupWriter

Delete an assignment group from Canvas. Optionally, move assignments in the deleted group to a new group. If not specified, these assignments are deleted.

Specified by:

deleteAssignmentGroup in interface AssignmentGroupWriter

Parameters:

options - Collection of optional parameters for the Canvas API call

Returns:

The deleted assignment group object

Throws:

IOException - When there is an error communicating with Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<AssignmentGroup,AssignmentGroupReader,AssignmentGroupWriter>

objectType

protected Class<AssignmentGroup> objectType()

Specified by:

objectType in class BaseImpl<AssignmentGroup,AssignmentGroupReader,AssignmentGroupWriter>