edu.ksu.canvas.requestOptions

Class BaseOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

Direct Known Subclasses:

AccountReportOptions, AddMessageToConversationOptions, AnswerQuizQuestionOptions, CompleteQuizSubmissionOptions, CreateCommunicationChannelOptions, CreateContentMigrationOptions, CreateConversationOptions, CreateSisImportOptions, CreateUserOptions, DeleteAssignmentGroupOptions, DeleteCalendarEventOptions, DeleteCourseOptions, GetAssignmentGroupOptions, GetEnrollmentOptions, GetEnrollmentTermOptions, GetQuizQuestionsOptions, GetQuizSubmissionsOptions, GetRubricOptions, GetSelectiveDataOptions, GetSingleAssignmentOptions, GetSingleConversationOptions, GetSingleCourseOptions, GetSubAccountsOptions, GetSubmissionsOptions, GetUsersInAccountOptions, GetUsersInCourseOptions, ListAccountAdminsOptions, ListAccountOptions, ListActiveCoursesInAccountOptions, ListAssignmentGroupOptions, ListCalendarEventsOptions, ListCourseAssignmentsOptions, ListCurrentUserCoursesOptions, ListExternalToolsOptions, ListModulesOptions, ListRolesOptions, ListUserCoursesOptions, MultipleSubmissionsOptions, StartQuizSubmissionOptions, UpdateCourseTabOptions, UploadOptions

public abstract class BaseOptions
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,List<String>>	optionsMap

Constructor Summary

Constructors

Constructor and Description
BaseOptions()

Method Summary

Modifier and Type	Method and Description
protected void	addEnumList(String key, List<? extends Enum> list) Add a list of enums to the options map
protected void	addNumberList(String key, List<? extends Number> list)
protected void	addSingleItem(String key, String value)
protected void	addStringList(String key, List<String> list)
Map<String,List<String>>	getOptionsMap()

Methods inherited from class java.lang.Object

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

Field Detail

optionsMap

protected Map<String,List<String>> optionsMap

Constructor Detail

BaseOptions

public BaseOptions()

Method Detail

getOptionsMap

public Map<String,List<String>> getOptionsMap()

addEnumList

protected void addEnumList(String key,
                           List<? extends Enum> list)

Add a list of enums to the options map

Parameters:

key - The key for the options map (ex: "include[]")

list - A list of enums

addSingleItem

protected void addSingleItem(String key,
                             String value)

addNumberList

protected void addNumberList(String key,
                             List<? extends Number> list)

addStringList

protected void addStringList(String key,
                             List<String> list)