edu.ksu.canvas.interfaces

Interface AccountReportSummaryReader

All Superinterfaces:

CanvasReader<AccountReportSummary,AccountReportSummaryReader>

All Known Implementing Classes:

AccountReportSummaryImpl

public interface AccountReportSummaryReader
extends CanvasReader<AccountReportSummary,AccountReportSummaryReader>

Method Summary

Modifier and Type	Method and Description
List<AccountReportSummary>	listAvailableReports(String accountId) Generate a list of reports available for the specified account.

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

listAvailableReports

List<AccountReportSummary> listAvailableReports(String accountId)
                                         throws IOException

Generate a list of reports available for the specified account. See the Canvas API documentation for more details.

Parameters:

accountId - the account ID to run the reports against

Returns:

a summary list of reports, showing the most recent runs if any exist

Throws:

IOException - When there is an error communicating with Canvas