edu.ksu.canvas.impl

Class AccountReportImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<AccountReport,AccountReportReader,AccountReportWriter>

edu.ksu.canvas.impl.AccountReportImpl

All Implemented Interfaces:

AccountReportReader, AccountReportWriter, CanvasReader<AccountReport,AccountReportReader>, CanvasWriter<AccountReport,AccountReportWriter>

public class AccountReportImpl
extends BaseImpl<AccountReport,AccountReportReader,AccountReportWriter>
implements AccountReportReader, AccountReportWriter

Field Summary

Fields inherited from class edu.ksu.canvas.impl.BaseImpl

apiVersion, canvasBaseUrl, canvasMessenger, masqueradeAs, masqueradeType, oauthToken, paginationPageSize, responseCallback, responseParser, serializeNulls

Constructor Summary

Constructors

Constructor and Description
AccountReportImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls)

Method Summary

Modifier and Type	Method and Description
Optional<AccountReport>	deleteReport(String accountId, String report, Integer reportId) Delete a report.
List<AccountReport>	listReports(String accountId, String report) Generate a list of previously run reports for a given report type.
protected Type	listType()
protected Class<AccountReport>	objectType()
Optional<AccountReport>	reportStatus(String accountId, String report, Integer id) Pull back the status of a given report.
Optional<AccountReport>	startReport(AccountReportOptions options) Start a new report, specifying a set of options to run with.

Methods inherited from class edu.ksu.canvas.impl.BaseImpl

buildCanvasUrl, encode, getFromCanvas, getListFromCanvas, parseListOfResponses, readAsCanvasUser, readAsSisUser, withCallback, writeAsCanvasUser, writeAsSisUser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

readAsCanvasUser, readAsSisUser, withCallback

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

writeAsCanvasUser, writeAsSisUser

Constructor Detail

AccountReportImpl

public AccountReportImpl(String canvasBaseUrl,
                         Integer apiVersion,
                         OauthToken oauthToken,
                         RestClient restClient,
                         int connectTimeout,
                         int readTimeout,
                         Integer paginationPageSize,
                         Boolean serializeNulls)

Method Detail

listReports

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

Description copied from interface: AccountReportReader

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

Specified by:

listReports in interface AccountReportReader

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

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

Description copied from interface: AccountReportReader

Pull back the status of a given report.

Specified by:

reportStatus in interface AccountReportReader

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

startReport

public Optional<AccountReport> startReport(AccountReportOptions options)
                                    throws IOException

Description copied from interface: AccountReportWriter

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.

Specified by:

startReport in interface AccountReportWriter

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

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

Description copied from interface: AccountReportWriter

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

Specified by:

deleteReport in interface AccountReportWriter

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

listType

protected Type listType()

Specified by:

listType in class BaseImpl<AccountReport,AccountReportReader,AccountReportWriter>

objectType

protected Class<AccountReport> objectType()

Specified by:

objectType in class BaseImpl<AccountReport,AccountReportReader,AccountReportWriter>