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

This session manages queries and sequencing to create "smart" dynamic catalogs. An AssessmentOfferedQuery can be retrieved from this session and mapped to this Bank to create a virtual collection of AssessmentsOffered. 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 AssessmentOfferedQueryInspector. The query may be modified by converting the inspector back to an AssessmentOfferedQuery.

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_DENIEDauthorization 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.
MethodgetAssessmentOfferedQuery
Description

Gets an assessment offered query.

Returnosid.assessment.AssessmentOfferedQuerythe assessment offered query
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentOfferedSearchOrder
Description

Gets an assessment offered search order.

Returnosid.assessment.AssessmentOfferedSearchOrderthe assessment offered search order
CompliancemandatoryThis method must be implemented.
MethodapplyAssessmentOfferedQuery
Description

Applies an assessment offered query to this bank.

Parametersosid.assessment.AssessmentOfferedQueryassessmentOfferedQuerythe assessment offered query
ErrorsNULL_ARGUMENT assessmentOfferedQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED assessmentOfferedQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectAssessmentOfferedQuery
Description

Gets an assessment offered query inspector for this bank.

Returnosid.assessment.AssessmentOfferedQueryInspectorthe assessment offered query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyAssessmentOfferedSequencing
Description

Applies an assessment offered search order to this bank.

Parametersosid.assessment.AssessmentOfferedSearchOrderassessmentOfferedSearchOrderthe assessment offered search order
ErrorsNULL_ARGUMENT assessmentOfferedSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED assessmentOfferedSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentOfferedQueryFromInspector
Description

Gets an assessment offered query from an inspector.

Parametersosid.assessment.AssessmentOfferedQueryInspectorassessmentOfferedQueryInspectora assessment offered query inspector
Returnosid.assessment.AssessmentOfferedQuerythe assessment offered query
ErrorsNULL_ARGUMENT assessmentOfferedQueryInspector is null
UNSUPPORTED assessmentOfferedQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.