edu.ksu.canvas.impl

Class SisImportImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<SisImport,SisImportReader,SisImportWriter>

edu.ksu.canvas.impl.SisImportImpl

All Implemented Interfaces:

CanvasReader<SisImport,SisImportReader>, CanvasWriter<SisImport,SisImportWriter>, SisImportReader, SisImportWriter

public class SisImportImpl
extends BaseImpl<SisImport,SisImportReader,SisImportWriter>
implements SisImportReader, SisImportWriter

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
SisImportImpl(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<SisImport>	createSisImport(CreateSisImportOptions options)
Optional<SisImport>	getSisImport(String accountId, Integer id) Returns a sis import.
protected Type	listType()
protected Class<SisImport>	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

SisImportImpl

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

Method Detail

getSisImport

public Optional<SisImport> getSisImport(String accountId,
                                        Integer id)
                                 throws IOException

Description copied from interface: SisImportReader

Returns a sis import.

Specified by:

getSisImport in interface SisImportReader

Parameters:

accountId - The account ID for this API call

id - The Canvas ID of the sis import to query

Returns:

A SisImport object

Throws:

IOException - When there is an error communicating with Canvas

createSisImport

public Optional<SisImport> createSisImport(CreateSisImportOptions options)
                                    throws IOException

Specified by:

createSisImport in interface SisImportWriter

Throws:

IOException

listType

protected Type listType()

Specified by:

listType in class BaseImpl<SisImport,SisImportReader,SisImportWriter>

objectType

protected Class<SisImport> objectType()

Specified by:

objectType in class BaseImpl<SisImport,SisImportReader,SisImportWriter>