Interface ProductSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProductSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ProductQueryInspector	getProductQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
ProductList	getProducts()	Gets the product list resulting from a search.
ProductSearchResultsRecord	getProductSearchResultsRecord(Type productSearchRecordType)	Gets the product search results record corresponding to the given product search record Type.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getProducts

ProductList getProducts()

Gets the product list resulting from a search.

Returns:

the product list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getProductQueryInspector

ProductQueryInspector getProductQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getProductSearchResultsRecord

ProductSearchResultsRecord getProductSearchResultsRecord(Type productSearchRecordType)
                                                  throws OperationFailedException

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.

Parameters:

productSearchRecordType - a product search record type

Returns:

the product search results record

Throws:

NullArgumentException - ProductSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(productSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.