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

This session provides methods for searching Item objects. The search query is constructed using the ItemQuery. The assessment item record Type also specifies the query record for the assessment item query.

This session defines views that offer differing behaviors for searching.

  • federated assessment bank view: searches include assessment items in assessment banks of which this assessment bank is a ancestor in the assessment bank hierarchy
  • isolated bank

Assessment items may have a query record indicated by their respective record types. Thequery record is accessed via the 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.
MethodcanSearchItems
Description

Tests if this user can perform Item searches. 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 pplication that may wish not to offer search operations to unauthorized users.

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

Federates the view for methods in this session. A federated view will include assessment items in assessment banks which are children of this assessment bank in the assessment bank hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBankView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this assessment bank only.

CompliancemandatoryThis method is must be implemented.
MethodgetItemQuery
Description

Gets an assessment item query.

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

Gets a list of Items matching the given item query.

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