edu.ksu.canvas.interfaces

Interface AccountReportReader

All Superinterfaces:

CanvasReader<AccountReport,AccountReportReader>

All Known Implementing Classes:

AccountReportImpl

public interface AccountReportReader
extends CanvasReader<AccountReport,AccountReportReader>

Method Summary

Modifier and Type	Method and Description
List<AccountReport>	listReports(String accountId, String report) Generate a list of previously run reports for a given report type.
Optional<AccountReport>	reportStatus(String accountId, String report, Integer id) Pull back the status of a given report.

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

listReports

List<AccountReport> listReports(String accountId,
                                String report)
                         throws IOException

Generate a list of previously run reports for a given report type.

Parameters:

accountId - the account ID to run the reports against

report - the specific name of the report (e.g. sis_export_csv)

Returns:

a list of run reports specified by the report ID

Throws:

IOException - When there is an error communicating with Canvas

reportStatus

Optional<AccountReport> reportStatus(String accountId,
                                     String report,
                                     Integer id)
                              throws IOException

Pull back the status of a given report.

Parameters:

accountId - the account ID to run the reports against

report - the specific name of the report (e.g. sis_export_csv)

id - the ID of the running report

Returns:

a report outlining the status of its run, or a summary of its completed run

Throws:

IOException - When there is an error communicating with Canvas