OSID Logo
OSID Specifications
assessment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.ItemSearch
Implementsosid.OsidSearch
Description

ItemSearch defines the interface for specifying item search options.

MethodsearchAmongItems
Description

Execute this search among the given list of items.

Parametersosid.id.IdListitemIdslist of items
ErrorsNULL_ARGUMENT itemIds is null
CompliancemandatoryThis method must be implemented.
MethodorderItemResults
Description

Specify an ordering to the search results.

Parametersosid.assessment.ItemSearchOrderitemSearchOrderitem search order
ErrorsNULL_ARGUMENT itemSearchOrder is null
UNSUPPORTED itemSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetItemSearchRecord
Description

Gets the item search record corresponding to the given item search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeitemSearchRecordTypean item search record type
Returnosid.assessment.records.ItemSearchRecordthe item search record
ErrorsNULL_ARGUMENT itemSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(itemSearchRecordType) is false
CompliancemandatoryThis method must be implemented.