edu.ksu.canvas.interfaces.SectionWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of canvas-api Show documentation

A native Java library to talk to the Canvas REST API

The newest version!

package edu.ksu.canvas.interfaces;

import java.io.IOException;
import java.util.Optional;

import edu.ksu.canvas.model.Section;

/**
 * Created by japshvincent on 4/28/16.
 */
public interface SectionWriter extends CanvasWriter {

    /**
     * Create a new section in Canvas.
     *
     * @param courseId identifies the parent course we are adding this section to
     * @param section a section object containing the information needed to create
     *         the section in Canvas
     * @param enableSisReactivation when true, will first try to re-activate a
     *         deleted section with matching sis_section_id if possible. Ignored if null
     * @return the newly created section
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional createSection(String courseId, Section section, Boolean enableSisReactivation) throws IOException;

    /**
     * Update a section in Canvas.
     *
     * @param section section object with changes made that will be persisted
     * @return the updated section
     * @throws IOException when there is an error communicating with Canvas
     */
    Optional updateSection(Section section) throws IOException;

    /**
     * Delete an existing section in Canvas.
     *
     * @param sectionId identifies the section to delete
     * @return the section object that was deleted
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional deleteSection(String sectionId) throws IOException;

    /**
     * Move the Section to another course in Canvas.
     *
     * @param sectionId identifies the section to move
     * @param courseId identifies the course to move the section into
     * @return the section object that was moved
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional crosslist(String sectionId, String courseId) throws IOException;
}