edu.ksu.canvas.interfaces

Interface SectionWriter

All Superinterfaces:

CanvasWriter<Section,SectionWriter>

All Known Implementing Classes:

SectionsImpl

public interface SectionWriter
extends CanvasWriter<Section,SectionWriter>

Created by japshvincent on 4/28/16.

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>	updateSection(Section section) Update a section in Canvas.

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

writeAsCanvasUser, writeAsSisUser

Method Detail

createSection

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

Create a new section in Canvas.

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

Optional<Section> updateSection(Section section)
                         throws IOException

Update a section in Canvas.

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

Optional<Section> deleteSection(String sectionId)
                         throws IOException

Delete an existing section in Canvas.

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

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

Move the Section to another course in Canvas.

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