edu.ksu.canvas.requestOptions

Class GetSingleCourseOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.GetSingleCourseOptions

public class GetSingleCourseOptions
extends BaseOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetSingleCourseOptions.Include

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
GetSingleCourseOptions(String courseId) Create an options object for retrieving a single course.

Method Summary

Modifier and Type	Method and Description
GetSingleCourseOptions	account(String accountId)
String	getAccount()
String	getCourseId()
GetSingleCourseOptions	includes(List<GetSingleCourseOptions.Include> includes) Include additional optional fields in the course objects

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

GetSingleCourseOptions

public GetSingleCourseOptions(String courseId)

Create an options object for retrieving a single course. Must have a course ID set.

Parameters:

courseId - Required: ID of the course to get. May be of the form sis_course_id:abc123

Method Detail

getCourseId

public String getCourseId()

includes

public GetSingleCourseOptions includes(List<GetSingleCourseOptions.Include> includes)

Include additional optional fields in the course objects

Parameters:

includes - List of additional fields to include

Returns:

This object to allow adding more options

account

public GetSingleCourseOptions account(String accountId)

getAccount

public String getAccount()