edu.ksu.canvas.interfaces.AccountReportSummaryReader Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of canvas-api Show documentation

A native Java library to talk to the Canvas REST API

The newest version!

package edu.ksu.canvas.interfaces;

import java.io.IOException;
import java.util.List;

import edu.ksu.canvas.model.report.AccountReportSummary;

public interface AccountReportSummaryReader extends CanvasReader {

    /**
     * Generate a list of reports available for the specified account.
     * See the Canvas API documentation for more details.
     * @param accountId the account ID to run the reports against
     * @return a summary list of reports, showing the most recent runs if any exist
     * @throws IOException When there is an error communicating with Canvas
     */
    List listAvailableReports(String accountId) throws IOException;
}