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

This session provides methods for retrieving Gradebook objects. The Gradebook represents a collection of grade systems, entries, and gradebook columns.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Gradebooks it can access, without breaking execution. However, an administrative application may require all Gradebook elements to be available.

Gradebooks may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Gradebook.

MethodcanLookupGradebooks
Description

Tests if this user can perform Gradebook lookups. 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 lookup operations to unauthorized users.

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

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryGradebookView
Description

A complete view of the Gradebook returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetGradebook
Description

Gets the Gradebook specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Gradebook may have a different Id than requested, such as the case where a duplicate Id was assigned to a Gradebook and retained for compatility.

Parametersosid.id.IdgradebookId Id of the Gradebook
Returnosid.grading.Gradebookthe gradebook
ErrorsNOT_FOUND gradebookId not found
NULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetGradebooksByIds
Description

Gets a GradebookList corresponding to the given IdList. In plenary mode, the returned list contains all of the gradebooks specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Gradebook objects may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListgradebookIdsthe list of Ids to retrieve
Returnosid.grading.GradebookListthe returned Gradebook list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT gradebookIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradebooksByGenusType
Description

Gets a GradebookList corresponding to the given gradebook genus Type which does not include gradebooks of types derived from the specified Type. In plenary mode, the returned list contains all known gradebooks or an error results. Otherwise, the returned list may contain only those gradebooks that are accessible through this session.

Parametersosid.type.TypegradebookGenusTypea gradebook genus type
Returnosid.grading.GradebookListthe returned Gradebook list
ErrorsNULL_ARGUMENT gradebookGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradebooksByParentGenusType
Description

Gets a GradebookList corresponding to the given gradebook genus Type and include any additional gradebooks with genus types derived from the specified Type. In plenary mode, the returned list contains all known gradebooks or an error results. Otherwise, the returned list may contain only those gradebooks that are accessible through this session.

Parametersosid.type.TypegradebookGenusTypea gradebook genus type
Returnosid.grading.GradebookListthe returned Gradebook list
ErrorsNULL_ARGUMENT gradebookGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradebooksByRecordType
Description

Gets a GradebookList containing the given gradebook record Type. In plenary mode, the returned list contains all known gradebooks or an error results. Otherwise, the returned list may contain only those gradebooks that are accessible through this session.

Parametersosid.type.TypegradebookRecordTypea gradebook record type
Returnosid.grading.GradebookListthe returned Gradebook list
ErrorsNULL_ARGUMENT gradebookRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradebooksByProvider
Description

Gets a GradebookList for the given provider . In plenary mode, the returned list contains all known gradebooks or an error results. Otherwise, the returned list may contain only those gradebooks that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.grading.GradebookListthe returned Gradebook list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradebooks
Description

Gets all Gradebooks. In plenary mode, the returned list contains all known gradebooks or an error results. Otherwise, the returned list may contain only those gradebooks that are accessible through this session.

Returnosid.grading.GradebookLista GradebookList
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.