OSID Logo
OSID Specifications
grading package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.GradebookQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching among Gradebook objects. The search query is constructed using the GradebookQuery.

Gradebooks may have a query record indicated by their respective record types. The query record is accessed via the GradebookQuery.

MethodcanSearchGradebooks
Description

Tests if this user can perform Gradebook searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradebookQuery
Description

Gets a gradebook query.

Returnosid.grading.GradebookQuerya gradebook query
CompliancemandatoryThis method must be implemented.
MethodgetGradebooksByQuery
Description

Gets a list of Gradebook objects matching the given gradebook query.

Parametersosid.grading.GradebookQuerygradebookQuerythe gradebook query
Returnosid.grading.GradebookListthe returned GradebookList
ErrorsNULL_ARGUMENT gradebookQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED gradebookQuery is not of this service
CompliancemandatoryThis method must be implemented.