OSID Logo
OSID Specifications
inventory package
Version 3.1.0
Interfaceosid.inventory.InventorySearchResults
Implementsosid.OsidSearchResults
Used Byosid.inventory.InventorySearchSession
Description

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

MethodgetInventories
Description

Gets the inventory list resulting from a search.

Returnosid.inventory.InventoryList the inventory list
ErrorsILLEGAL_STATE the inventory list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetInventoryQueryInspector
Description

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

Returnosid.inventory.InventoryQueryInspector the query inspector
Compliancemandatory This 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.TypeinventorySearchRecordType an inventory search record type
Returnosid.inventory.records.InventorySearchResultsRecord the inventory search interface
ErrorsNULL_ARGUMENT inventorySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(inventorySearchRecordType) is false
Compliancemandatory This method must be implemented.