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

This session provides methods for searching GradebookColumn objects. The search query is constructed using the GradebookColumnQuery.

This session defines views that offer differing behaviors for searching.

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

Gradebook columns may have a query record indicated by their respective record types. The query record is accessed via the GradebookColumnQuery.

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.
MethodcanSearchGradebookColumns
Description

Tests if this user can perform GradebookColumn 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 gradebook columns 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.
MethodgetGradebookColumnQuery
Description

Gets a gradebook column query.

Returnosid.grading.GradebookColumnQuerythe gradebook column
CompliancemandatoryThis method must be implemented.
MethodgetGradebookColumnsByQuery
Description

Gets a list of gradebook columns matching the given query.

Parametersosid.grading.GradebookColumnQuerygradebookColumnQuerythe gradebook column query
Returnosid.grading.GradebookColumnListthe returned GradebookColumnList
ErrorsNULL_ARGUMENT gradebookColumnQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED gradebookColumnQuery is not of this service
CompliancemandatoryThis method must be implemented.