edu.ksu.canvas.requestOptions

Class AccountReportOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.AccountReportOptions

public class AccountReportOptions
extends BaseOptions

Account report form options to create a new report.

Note that these options vary depending on the type of report you wish to generate, and not all options are required. However, you may require at least one option to ensure that your report is created successfully.

See Start a Report for more details.

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
AccountReportOptions(String reportType, String accountId)

Method Summary

Modifier and Type	Method and Description
AccountReportOptions	accounts(String parameter)
AccountReportOptions	admins(String parameter)
AccountReportOptions	courses(String parameter)
AccountReportOptions	createdBySis(String parameter)
AccountReportOptions	enrollments(String parameter)
AccountReportOptions	enrollmentTermId(String parameter)
String	getAccountId()
String	getReportType()
AccountReportOptions	groupCategories(String parameter)
AccountReportOptions	groupMembership(String parameter)
AccountReportOptions	groups(String parameter)
AccountReportOptions	includeDeleted(String parameter)
AccountReportOptions	sections(String parameter)
AccountReportOptions	terms(String parameter)
AccountReportOptions	userObservers(String parameter)
AccountReportOptions	users(String parameter)
AccountReportOptions	xlist(String parameter)

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

AccountReportOptions

public AccountReportOptions(String reportType,
                            String accountId)

Method Detail

getReportType

public String getReportType()

getAccountId

public String getAccountId()

enrollmentTermId

public AccountReportOptions enrollmentTermId(String parameter)

users

public AccountReportOptions users(String parameter)

accounts

public AccountReportOptions accounts(String parameter)

terms

public AccountReportOptions terms(String parameter)

courses

public AccountReportOptions courses(String parameter)

sections

public AccountReportOptions sections(String parameter)

enrollments

public AccountReportOptions enrollments(String parameter)

groups

public AccountReportOptions groups(String parameter)

groupCategories

public AccountReportOptions groupCategories(String parameter)

groupMembership

public AccountReportOptions groupMembership(String parameter)

xlist

public AccountReportOptions xlist(String parameter)

userObservers

public AccountReportOptions userObservers(String parameter)

admins

public AccountReportOptions admins(String parameter)

createdBySis

public AccountReportOptions createdBySis(String parameter)

includeDeleted

public AccountReportOptions includeDeleted(String parameter)