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

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

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

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 assessment. 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.
MethodgetItemQuery
Description

Gets an assessment item query.

Returnosid.assessment.ItemQuerythe assessment item query
CompliancemandatoryThis method must be implemented.
MethodgetItemSearchOrder
Description

Gets an assessment item search order.

Returnosid.assessment.ItemSearchOrderthe assessment item search order
CompliancemandatoryThis method must be implemented.
MethodapplyItemQuery
Description

Applies an item query to this bank.

Parametersosid.assessment.ItemQueryitemQuerythe item query
ErrorsNULL_ARGUMENT itemQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED itemQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectItemQuery
Description

Gets an item query inspector for this bank.

Returnosid.assessment.ItemQueryInspectorthe item query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyItemSequencing
Description

Applies an item search order to this bank.

Parametersosid.assessment.ItemSearchOrderitemSearchOrderthe item search order
ErrorsNULL_ARGUMENT itemSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED itemSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetItemQueryFromInspector
Description

Gets an item query from an inspector.

Parametersosid.assessment.ItemQueryInspectoritemQueryInspectoran item query inspector
Returnosid.assessment.ItemQuerythe item query
ErrorsNULL_ARGUMENT itemQueryInspector is null
UNSUPPORTED itemQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.