OSID Logo
OSID Specifications
ordering package
Version 3.1.0
Interfaceosid.ordering.ProductSearchResults
Implementsosid.OsidSearchResults
Used Byosid.ordering.ProductSearchSession
Description

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

MethodgetProducts
Description

Gets the product list resulting from a search.

Returnosid.ordering.ProductList the product list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetProductQueryInspector
Description

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

Returnosid.ordering.ProductQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetProductSearchResultsRecord
Description

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

Parametersosid.type.TypeproductSearchRecordType a product search record type
Returnosid.ordering.records.ProductSearchResultsRecord the product search results record
ErrorsNULL_ARGUMENT ProductSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(productSearchRecordType) is false
Compliancemandatory This method must be implemented.