OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.ItemSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetItems
Description

Gets the item list resulting from a search.

Returnosid.inventory.ItemListthe item list
ErrorsILLEGAL_STATEthe item list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetItemQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.inventory.ItemQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetItemSearchResultsRecord
Description

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

Parametersosid.type.TypeitemSearchRecordTypea item search record type
Returnosid.inventory.records.ItemSearchResultsRecordthe item search results record
ErrorsNULL_ARGUMENT itemSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(itemSearchRecordType) is false
CompliancemandatoryThis method must be implemented.