edu.ksu.canvas.requestOptions

Class DeleteCourseOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.DeleteCourseOptions

public class DeleteCourseOptions
extends BaseOptions

Encapsulates the allowed input to the Canvas API DELETE call for courses.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeleteCourseOptions.EventType The event: whether we are deleting a course permanently, or marking it as concluded.

Field Summary

Fields inherited from class edu.ksu.canvas.requestOptions.BaseOptions

optionsMap

Constructor Summary

Constructors

Constructor and Description
DeleteCourseOptions(String courseId, DeleteCourseOptions.EventType eventType) Constructor.

Method Summary

Modifier and Type	Method and Description
DeleteCourseOptions	accountId(String accountId)
String	getAccountId()
String	getCourseId()
DeleteCourseOptions.EventType	getEventType()

Methods inherited from class edu.ksu.canvas.requestOptions.BaseOptions

addEnumList, addNumberList, addSingleItem, addStringList, getOptionsMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeleteCourseOptions

public DeleteCourseOptions(String courseId,
                           DeleteCourseOptions.EventType eventType)

Constructor.

Parameters:

courseId - identifies the course to delete

eventType - whether to delete or conclude the course

Method Detail

accountId

public DeleteCourseOptions accountId(String accountId)

getCourseId

public String getCourseId()

getEventType

public DeleteCourseOptions.EventType getEventType()

getAccountId

public String getAccountId()