edu.ksu.canvas.impl

Class ProgressImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<Progress,ProgressReader,ProgressWriter>

edu.ksu.canvas.impl.ProgressImpl

All Implemented Interfaces:

CanvasReader<Progress,ProgressReader>, CanvasWriter<Progress,ProgressWriter>, ProgressReader, ProgressWriter

public class ProgressImpl
extends BaseImpl<Progress,ProgressReader,ProgressWriter>
implements ProgressReader, ProgressWriter

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
ProgressImpl(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<Progress>	getProgress(Integer progressId) Returns the progress of an asynchronous process by progress ID
Optional<Progress>	getProgress(String url) Returns the progress of an asynchronous process by progress URL
protected Type	listType()
protected Class<Progress>	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

ProgressImpl

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

Method Detail

getProgress

public Optional<Progress> getProgress(String url)
                               throws IOException

Description copied from interface: ProgressReader

Returns the progress of an asynchronous process by progress URL

Specified by:

getProgress in interface ProgressReader

Parameters:

url - The URL to query for progress

Returns:

A Progress object

Throws:

IOException - When there is an error communicating with Canvas

getProgress

public Optional<Progress> getProgress(Integer progressId)
                               throws IOException

Description copied from interface: ProgressReader

Returns the progress of an asynchronous process by progress ID

Specified by:

getProgress in interface ProgressReader

Parameters:

progressId - ID of the progress object to query

Returns:

The requested Progress object

Throws:

IOException - When there is an error communicating with Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<Progress,ProgressReader,ProgressWriter>

objectType

protected Class<Progress> objectType()

Specified by:

objectType in class BaseImpl<Progress,ProgressReader,ProgressWriter>