edu.ksu.canvas.interfaces

Interface GradingStandardReader

All Superinterfaces:

CanvasReader<GradingStandard,GradingStandardReader>

All Known Implementing Classes:

GradingStandardImpl

public interface GradingStandardReader
extends CanvasReader<GradingStandard,GradingStandardReader>

Method Summary

Modifier and Type	Method and Description
Optional<GradingStandard>	getGradingStandardInAccount(String accountId, Long gradingStandardId) Get a specific grading standard from within an account
Optional<GradingStandard>	getGradingStandardInCourse(String courseId, Long gradingStandardId) Get a specific grading standard from within a course
List<GradingStandard>	listGradingStandardsInAccount(String accountId) List grading standards associated with an account
List<GradingStandard>	listGradingStandardsInCourse(String courseId) List grading standards associated with a given course

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

listGradingStandardsInCourse

List<GradingStandard> listGradingStandardsInCourse(String courseId)
                                            throws IOException

List grading standards associated with a given course

Parameters:

courseId - The Canvas course ID or sis_course_id:xxxx

Returns:

A list of grading standards in the course

Throws:

IOException - if there is an error communicating with Canvas

listGradingStandardsInAccount

List<GradingStandard> listGradingStandardsInAccount(String accountId)
                                             throws IOException

List grading standards associated with an account

Parameters:

accountId - The Canvas account ID or sis_account_id:xxxx

Returns:

A list of grading standards in the account

Throws:

IOException - if there is an error communicating with Canvas

getGradingStandardInCourse

Optional<GradingStandard> getGradingStandardInCourse(String courseId,
                                                     Long gradingStandardId)
                                              throws IOException

Get a specific grading standard from within a course

Parameters:

courseId - Canvas course ID or sis_course_id:xxxx

gradingStandardId - Canvas grading standard ID

Returns:

The requested grading standard

Throws:

IOException - if there is an error communicating with Canvas

getGradingStandardInAccount

Optional<GradingStandard> getGradingStandardInAccount(String accountId,
                                                      Long gradingStandardId)
                                               throws IOException

Get a specific grading standard from within an account

Parameters:

accountId - Canvas account ID or sis_account_id:xxxx

gradingStandardId - Canvas grading standard ID

Returns:

The requested grading standard

Throws:

IOException - if there is an error communicating with Canvas