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

This session provides methods for searching GradeEntry objects. The search query is constructed using the GradeEntryQuery. The grade entry record Type also specifies the record interface for the grade entry query.

This session defines views that offer differing behaviors for searching.

  • federated gradebook view: searches include grade entries in gradebooks of which this gradebook is a ancestor in the gradebook hierarchy
  • isolated gradebook view: searches are restricted to grade entries in this gradebook

Grade entries may have a query record indicated by their respective record types. The query record is accessed via the GradeEntryQuery.

MethodgetGradebookId
Description

Gets the Gradebook Id associated with this session.

Returnosid.id.Idthe Gradebook Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetGradebook
Description

Gets the Gradebook associated with this session.

Returnosid.grading.Gradebookthe Gradebook associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchGradeEntries
Description

Tests if this user can perform GradeEntry 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.
MethoduseFederatedGradebookView
Description

Federates the view for methods in this session. A federated view will include grade entries in gradebooks which are children of this gradebook in the gradebook hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedGradebookView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this gradebook only.

CompliancemandatoryThis method is must be implemented.
MethodgetGradeEntryQuery
Description

Gets a grade entry query.

Returnosid.grading.GradeEntryQuerythe grade entry query
CompliancemandatoryThis method must be implemented.
MethodgetGradeEntriesByQuery
Description

Gets a list of entries matching the given grade entry query.

Parametersosid.grading.GradeEntryQuerygradeEntryQuerythe grade entry query
Returnosid.grading.GradeEntryListthe returned GradeEntryList
ErrorsNULL_ARGUMENT gradeEntryQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED gradeEntryQuery is not of this service
CompliancemandatoryThis method must be implemented.