OSID Logo
OSID Specifications
assessment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.AssessmentSmartBankSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. An AssessmentQuery can be retrieved from this session and mapped to this Bank to create a virtual collection of Assessments. The assessments may be sequenced using the AssessmentSearchOrder from this session.

This Bank has a default query that matches any assessment and a default search order that specifies no sequencing. The queries may be examined using an AssessmentQueryInspector. The query may be modified by converting the inspector back to an AssessmentQuery.

MethodgetBankId
Description

Gets the Bank Id associated with this session.

Returnosid.id.Idthe Bank Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBank
Description

Gets the Bank associated with this session.

Returnosid.assessment.Bankthe Bank associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDassessment failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartBanks
Description

Tests if this user can manage smart banks. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart bank management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentQuery
Description

Gets an assessment query.

Returnosid.assessment.AssessmentQuerythe assessment query
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentSearchOrder
Description

Gets an assessment search order.

Returnosid.assessment.AssessmentSearchOrderthe assessment search order
CompliancemandatoryThis method must be implemented.
MethodapplyAssessmentQuery
Description

Applies an assessment query to this bank.

Parametersosid.assessment.AssessmentQueryassessmentQuerythe assessment query
ErrorsNULL_ARGUMENT assessmentQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED assessmentQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectAssessmentQuery
Description

Gets an assessment query inspector for this bank.

Returnosid.assessment.AssessmentQueryInspectorthe assessment query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyAssessmentSequencing
Description

Applies an assessment search order to this bank.

Parametersosid.assessment.AssessmentSearchOrderassessmentSearchOrderthe assessment search order
ErrorsNULL_ARGUMENT assessmentSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED assessmentSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentQueryFromInspector
Description

Gets an assessment query from an inspector.

Parametersosid.assessment.AssessmentQueryInspectorassessmentQueryInspectoran assessment query inspector
Returnosid.assessment.AssessmentQuerythe assessment query
ErrorsNULL_ARGUMENT assessmentQueryInspector is null
UNSUPPORTED assessmentQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.