edu.ksu.canvas.impl

Class AccountReportSummaryImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<AccountReportSummary,AccountReportSummaryReader,AccountReportSummaryWriter>

edu.ksu.canvas.impl.AccountReportSummaryImpl

All Implemented Interfaces:

AccountReportSummaryReader, AccountReportSummaryWriter, CanvasReader<AccountReportSummary,AccountReportSummaryReader>, CanvasWriter<AccountReportSummary,AccountReportSummaryWriter>

public class AccountReportSummaryImpl
extends BaseImpl<AccountReportSummary,AccountReportSummaryReader,AccountReportSummaryWriter>
implements AccountReportSummaryReader, AccountReportSummaryWriter

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
AccountReportSummaryImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls)

Method Summary

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

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

AccountReportSummaryImpl

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

Method Detail

listAvailableReports

public List<AccountReportSummary> listAvailableReports(String accountId)
                                                throws IOException

Description copied from interface: AccountReportSummaryReader

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

Specified by:

listAvailableReports in interface AccountReportSummaryReader

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

listType

protected Type listType()

Specified by:

listType in class BaseImpl<AccountReportSummary,AccountReportSummaryReader,AccountReportSummaryWriter>

objectType

protected Class<AccountReportSummary> objectType()

Specified by:

objectType in class BaseImpl<AccountReportSummary,AccountReportSummaryReader,AccountReportSummaryWriter>