edu.ksu.canvas.impl

Class SectionsImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<Section,SectionReader,SectionWriter>

edu.ksu.canvas.impl.SectionsImpl

All Implemented Interfaces:

CanvasReader<Section,SectionReader>, CanvasWriter<Section,SectionWriter>, SectionReader, SectionWriter

public class SectionsImpl
extends BaseImpl<Section,SectionReader,SectionWriter>
implements SectionReader, SectionWriter

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
SectionsImpl(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<Section>	createSection(String courseId, Section section, Boolean enableSisReactivation) Create a new section in Canvas.
Optional<Section>	crosslist(String sectionId, String courseId) Move the Section to another course in Canvas.
Optional<Section>	deleteSection(String sectionId) Delete an existing section in Canvas.
Optional<Section>	getSingleSection(String sectionId) Return a single section with a given section ID
List<Section>	listCourseSections(String courseId, List<SectionIncludes> includes) Return a list of sections in a given course
protected Type	listType()
protected Class<Section>	objectType()
Optional<Section>	updateSection(Section section) Update a section in Canvas.

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

SectionsImpl

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

Method Detail

listCourseSections

public List<Section> listCourseSections(String courseId,
                                        List<SectionIncludes> includes)
                                 throws IOException

Description copied from interface: SectionReader

Return a list of sections in a given course

Specified by:

listCourseSections in interface SectionReader

Parameters:

courseId - Canvas ID of course

includes - Optional information to include in the returned sections

Returns:

List of sections

Throws:

IOException - When there is an error communicating with Canvas

getSingleSection

public Optional<Section> getSingleSection(String sectionId)
                                   throws IOException

Description copied from interface: SectionReader

Return a single section with a given section ID

Specified by:

getSingleSection in interface SectionReader

Parameters:

sectionId - Section ID of section

Returns:

The section

Throws:

IOException - When there is an error communicating with Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<Section,SectionReader,SectionWriter>

objectType

protected Class<Section> objectType()

Specified by:

objectType in class BaseImpl<Section,SectionReader,SectionWriter>

createSection

public Optional<Section> createSection(String courseId,
                                       Section section,
                                       Boolean enableSisReactivation)
                                throws IOException

Description copied from interface: SectionWriter

Create a new section in Canvas.

Specified by:

createSection in interface SectionWriter

Parameters:

courseId - identifies the parent course we are adding this section to

section - a section object containing the information needed to create the section in Canvas

enableSisReactivation - when true, will first try to re-activate a deleted section with matching sis_section_id if possible. Ignored if null

Returns:

the newly created section

Throws:

IOException - When there is an error communicating with Canvas

updateSection

public Optional<Section> updateSection(Section section)
                                throws IOException

Description copied from interface: SectionWriter

Update a section in Canvas.

Specified by:

updateSection in interface SectionWriter

Parameters:

section - section object with changes made that will be persisted

Returns:

the updated section

Throws:

IOException - when there is an error communicating with Canvas

deleteSection

public Optional<Section> deleteSection(String sectionId)
                                throws IOException

Description copied from interface: SectionWriter

Delete an existing section in Canvas.

Specified by:

deleteSection in interface SectionWriter

Parameters:

sectionId - identifies the section to delete

Returns:

the section object that was deleted

Throws:

IOException - When there is an error communicating with Canvas

crosslist

public Optional<Section> crosslist(String sectionId,
                                   String courseId)
                            throws IOException

Description copied from interface: SectionWriter

Move the Section to another course in Canvas.

Specified by:

crosslist in interface SectionWriter

Parameters:

sectionId - identifies the section to move

courseId - identifies the course to move the section into

Returns:

the section object that was moved

Throws:

IOException - When there is an error communicating with Canvas