edu.ksu.canvas.interfaces

Interface SectionReader

All Superinterfaces:

CanvasReader<Section,SectionReader>

All Known Implementing Classes:

SectionsImpl

public interface SectionReader
extends CanvasReader<Section,SectionReader>

Methods to read information from and about sections

Method Summary

Modifier and Type	Method and Description
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

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

listCourseSections

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

Return a list of sections in a given course

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

Optional<Section> getSingleSection(String sectionId)
                            throws IOException

Return a single section with a given section ID

Parameters:

sectionId - Section ID of section

Returns:

The section

Throws:

IOException - When there is an error communicating with Canvas