edu.ksu.canvas.interfaces

Interface AccountReportWriter

All Superinterfaces:

CanvasWriter<AccountReport,AccountReportWriter>

All Known Implementing Classes:

AccountReportImpl

public interface AccountReportWriter
extends CanvasWriter<AccountReport,AccountReportWriter>

Method Summary

Modifier and Type	Method and Description
Optional<AccountReport>	deleteReport(String accountId, String report, Integer reportId) Delete a report.
Optional<AccountReport>	startReport(AccountReportOptions options) Start a new report, specifying a set of options to run with.

Methods inherited from interface edu.ksu.canvas.interfaces.CanvasWriter

writeAsCanvasUser, writeAsSisUser

Method Detail

startReport

Optional<AccountReport> startReport(AccountReportOptions options)
                             throws IOException

Start a new report, specifying a set of options to run with.

Note that the options used vary depending on the report you wish to start.

Parameters:

options - options that should be passed to start the report

Returns:

an Optional<AccountReport> which contains a reference to the generated report

Throws:

IOException - When there is an error communicating with Canvas

See Also:

Account Report API documentation, AccountReportOptions

deleteReport

Optional<AccountReport> deleteReport(String accountId,
                                     String report,
                                     Integer reportId)
                              throws IOException

Delete a report. This can also be used to stop the run of a report.

Parameters:

accountId - the account id used to generate the report

report - the name of the report

reportId - the ID of the report

Returns:

an Optional<AccountReport> which contains a reference to the deleted report

Throws:

IOException - When there is an error communicating with Canvas

See Also:

Account Report API documentation