OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.StoreSearchResults
Implementsosid.OsidSearchResults
Used Byosid.ordering.StoreSearchSession
Description

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

MethodgetStores
Description

Gets the store list resulting from a search.

Returnosid.ordering.StoreList the store list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetStoreQueryInspector
Description

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

Returnosid.ordering.StoreQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetStoreSearchResultsRecord
Description

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

Parametersosid.type.TypestoreSearchRecordType a store search record type
Returnosid.ordering.records.StoreSearchResultsRecord the store search results record
ErrorsNULL_ARGUMENT storeSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(storeSearchRecordType) is false
Compliancemandatory This method must be implemented.