OSID Logo
OSID Specifications
assessment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.ItemSearchSession
Implementsosid.assessment.ItemQuerySession
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.

getItemsByQuery() is the basic search method and returns a list of Items. A more advanced search may be performed with getItemsBySearch(). It accepts an ItemSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getItemsBySearch() returns an ItemSearchResults that can be used to access the resulting ItemList or be used to perform a search within the result set through ItemSearch.

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 view: searches are restricted to assessment items in this assessment bank

Assessment items may have a query record indicated by their respective record types. The query record is accessed via the ItemQuery.

MethodgetItemSearch
Description

Gets an assessment item search.

Returnosid.assessment.ItemSearchthe assessment item search
CompliancemandatoryThis method must be implemented.
MethodgetItemSearchOrder
Description

Gets an assessment item search order. The ItemSearchOrder is supplied to an ItemSearch to specify the ordering of results.

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

Gets the search results matching the given search query using the given search.

Parametersosid.assessment.ItemQueryitemQuerythe item query
osid.assessment.ItemSearchitemSearchthe item search
Returnosid.assessment.ItemSearchResultsthe returned search results
ErrorsNULL_ARGUMENT itemQuery or itemSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED itemSearch or itemQuery is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetItemQueryFromInspector
Description

Gets an item query from an inspector. The inspector is available from an ItemSearchResults.

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