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

This session provides methods for retrieving GradebookColumns .

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
  • isolated gradebook view: All gradebook column methods in this session operate, retrieve and pertain to gradebook columns defined explicitly in the current gradebook. Using an isolated view is useful for managing gradebook columns with the GradebookColumnAdminSession.
  • federated gradebook view: All gradebook column methods in this session operate, retrieve and pertain to all gradebook columns defined in this gradebook and any other gradebooks implicitly available in this gradebook through gradebook inheritence.

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

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

Tests if this user can perform GradebookColumn 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.
MethoduseComparativeGradebookColumnView
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.
MethodusePlenaryGradebookColumnView
Description

A complete view of the GradebookColumn 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.
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 lookups to this gradebook only.

CompliancemandatoryThis method is must be implemented.
MethodgetGradebookColumn
Description

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

Parametersosid.id.IdgradebookColumnId Id of the GradebookColumn
Returnosid.grading.GradebookColumnthe gradebook column
ErrorsNOT_FOUND gradebookColumnId not found
NULL_ARGUMENT gradebookColumnId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetGradebookColumnsByIds
Description

Gets a GradebookColumnList corresponding to the given IdList. In plenary mode, the returned list contains all of the gradebook columns specified in the Id list, in the order of the list, including duplicates, or an error results if a Id in the supplied list is not found or inaccessible. Otherwise, inaccessible gradeboook columns may be omitted from the list.

Parametersosid.id.IdListgradebookColumnIdsthe list of Ids to retrieve
Returnosid.grading.GradebookColumnListthe returned GradebookColumn list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT gradeBookColumnIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradebookColumnsByGenusType
Description

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

Parametersosid.type.TypegradebookColumnGenusTypea gradebook column genus type
Returnosid.grading.GradebookColumnListthe returned GradebookColumn list
ErrorsNULL_ARGUMENT gradebookColumnGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradebookColumnsByParentGenusType
Description

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

Parametersosid.type.TypegradebookColumnGenusTypea gradebook column genus type
Returnosid.grading.GradebookColumnListthe returned GradebookColumn list
ErrorsNULL_ARGUMENT gradebookColumnGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradebookColumnsByRecordType
Description

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

Parametersosid.type.TypegradebookColumnRecordTypea gradebook column record type
Returnosid.grading.GradebookColumnListthe returned GradebookColumn list
ErrorsNULL_ARGUMENT gradebookColumnRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradebookColumns
Description

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

Returnosid.grading.GradebookColumnLista GradebookColumn
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodsupportsSummary
Description

Tests if a summary entry is available.

Returnboolean true if a summary entry is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradebookColumnSummary
Description

Gets the GradebookColumnSummary for summary results.

Parametersosid.id.IdgradebookColumnId Id of the GradebookColumn
Returnosid.grading.GradebookColumnSummarythe gradebook column summary
ErrorsNOT_FOUND gradebookColumnId is not found
NULL_ARGUMENT gradebookColumnId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNIMPLEMENTED hasSummary() is false
CompliancemandatoryThis method is must be implemented.