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

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

MethodgetInventories
Description

Gets the inventory list resulting from a search.

Returnosid.inventory.InventoryListthe inventory list
ErrorsILLEGAL_STATEthe inventory list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetInventoryQueryInspector
Description

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

Returnosid.inventory.InventoryQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetInventorySearchResultsRecord
Description

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

Parametersosid.type.TypeinventorySearchRecordTypea inventory search record type
Returnosid.inventory.records.InventorySearchResultsRecordthe inventory search interface
ErrorsNULL_ARGUMENT inventorySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(inventorySearchRecordType) is false
CompliancemandatoryThis method must be implemented.