edu.ksu.canvas.requestOptions

Class GetEnrollmentTermOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.GetEnrollmentTermOptions

public class GetEnrollmentTermOptions
extends BaseOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetEnrollmentTermOptions.Include

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
GetEnrollmentTermOptions(String accountID) Create an options object for retrieving enrollment terms.

Method Summary

Modifier and Type	Method and Description
String	getAccountId()
GetEnrollmentTermOptions	includes(List<GetEnrollmentTermOptions.Include> includes) Include additional optional fields in the enrollment term 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

GetEnrollmentTermOptions

public GetEnrollmentTermOptions(String accountID)

Create an options object for retrieving enrollment terms. Must have the account ID set.

Parameters:

accountID - Required: ID of the canvas account.

Method Detail

includes

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

Include additional optional fields in the enrollment term objects

Parameters:

includes - List of additional fields to include

Returns:

This object to allow adding more options

getAccountId

public String getAccountId()