edu.ksu.canvas.impl

Class EnrollmentImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<Enrollment,EnrollmentReader,EnrollmentWriter>

edu.ksu.canvas.impl.EnrollmentImpl

All Implemented Interfaces:

CanvasReader<Enrollment,EnrollmentReader>, CanvasWriter<Enrollment,EnrollmentWriter>, EnrollmentReader, EnrollmentWriter

public class EnrollmentImpl
extends BaseImpl<Enrollment,EnrollmentReader,EnrollmentWriter>
implements EnrollmentReader, EnrollmentWriter

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
EnrollmentImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls)

Method Summary

Modifier and Type	Method and Description
Optional<Enrollment>	dropUser(String courseId, String enrollmentId) Drop a user enrolled in a course using the Unenrollment option of DELETE.
Optional<Enrollment>	dropUser(String courseId, String enrollmentId, UnEnrollOptions unEnrollOption) Drop a user enrolled in a course passing the UnEnrollOptions string in the task param.
Optional<Enrollment>	enrollUser(Enrollment enrollment) Deprecated.
Optional<Enrollment>	enrollUserInCourse(Enrollment enrollment) Enrolls a user in a course
Optional<Enrollment>	enrollUserInSection(Enrollment enrollment) Enrolls a user in a section.
List<Enrollment>	getCourseEnrollments(GetEnrollmentOptions options) Retrieve enrollments in a given course.
List<Enrollment>	getSectionEnrollments(GetEnrollmentOptions options) Retrieve enrollments in a given section.
List<Enrollment>	getUserEnrollments(GetEnrollmentOptions options) Retrieve a user's enrollments.
protected Type	listType()
protected Class<Enrollment>	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

EnrollmentImpl

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

Method Detail

getUserEnrollments

public List<Enrollment> getUserEnrollments(GetEnrollmentOptions options)
                                    throws IOException

Description copied from interface: EnrollmentReader

Retrieve a user's enrollments. Object ID in the options class must be a user ID.

Specified by:

getUserEnrollments in interface EnrollmentReader

Parameters:

options - API options available to this call

Returns:

List of the user's enrollments

Throws:

IOException - When there is an error communicating with Canvas

getSectionEnrollments

public List<Enrollment> getSectionEnrollments(GetEnrollmentOptions options)
                                       throws IOException

Description copied from interface: EnrollmentReader

Retrieve enrollments in a given section. Object ID in the options class must be a section ID.

Specified by:

getSectionEnrollments in interface EnrollmentReader

Parameters:

options - API options available to this call

Returns:

List of enrollments in a section

Throws:

IOException - When there is an error communicating with Canvas

getCourseEnrollments

public List<Enrollment> getCourseEnrollments(GetEnrollmentOptions options)
                                      throws IOException

Description copied from interface: EnrollmentReader

Retrieve enrollments in a given course. Object ID in the options class must be a course ID.

Specified by:

getCourseEnrollments in interface EnrollmentReader

Parameters:

options - API options available to this call

Returns:

List of enrollments in a course

Throws:

IOException - When there is an error communicating with Canvas

enrollUser

@Deprecated
public Optional<Enrollment> enrollUser(Enrollment enrollment)
                                            throws IOException

Deprecated.

Description copied from interface: EnrollmentWriter

Enroll a user in a course.

Specified by:

enrollUser in interface EnrollmentWriter

Parameters:

enrollment - partially populated Enrollment object

Returns:

optional enrollment

Throws:

IOException - if there is an error communicating with Canvas

enrollUserInCourse

public Optional<Enrollment> enrollUserInCourse(Enrollment enrollment)
                                        throws IOException

Description copied from interface: EnrollmentWriter

Enrolls a user in a course

Specified by:

enrollUserInCourse in interface EnrollmentWriter

Parameters:

enrollment - partially populated Enrollment object

Returns:

optional enrollment

Throws:

IOException - if there is an error communicating with Canvas

enrollUserInSection

public Optional<Enrollment> enrollUserInSection(Enrollment enrollment)
                                         throws IOException

Description copied from interface: EnrollmentWriter

Enrolls a user in a section.

Specified by:

enrollUserInSection in interface EnrollmentWriter

Parameters:

enrollment - partially populated Enrollment object

Returns:

optional enrollment

Throws:

IOException - if there is an error communicating with Canvas

dropUser

public Optional<Enrollment> dropUser(String courseId,
                                     String enrollmentId)
                              throws IOException

Description copied from interface: EnrollmentWriter

Drop a user enrolled in a course using the Unenrollment option of DELETE.

Specified by:

dropUser in interface EnrollmentWriter

Parameters:

courseId - - Canvas course identifier

enrollmentId - enrollmentId - Canvas enrollment identifier

Returns:

Populated Enrollment Dropped when successful

Throws:

IOException - if there is an error communicating with Canvas

dropUser

public Optional<Enrollment> dropUser(String courseId,
                                     String enrollmentId,
                                     UnEnrollOptions unEnrollOption)
                              throws IOException

Description copied from interface: EnrollmentWriter

Drop a user enrolled in a course passing the UnEnrollOptions string in the task param.

Specified by:

dropUser in interface EnrollmentWriter

Parameters:

courseId - - Canvas course identifier

enrollmentId - - Canvas enrollment identifier

unEnrollOption - - UnEnrollOption enum value of delete, conclude, inactivate or deactivate

Returns:

Populated Enrollment Dropped when successful

Throws:

IOException - if there is an error communicating with Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<Enrollment,EnrollmentReader,EnrollmentWriter>

objectType

protected Class<Enrollment> objectType()

Specified by:

objectType in class BaseImpl<Enrollment,EnrollmentReader,EnrollmentWriter>