Interface ProductSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProductSearch
extends OsidSearch

The search interface for governing product searches.

Method Summary

Modifier and Type	Method	Description
ProductSearchRecord	getProductSearchRecord(Type productSearchRecordType)	Gets the product search record corresponding to the given product search record Type.
void	orderProductResults(ProductSearchOrder productSearchOrder)	Specify an ordering to the search results.
void	searchAmongProducts(IdList productIds)	Execute this search among the given list of products.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongProducts

void searchAmongProducts(IdList productIds)

Execute this search among the given list of products.

Parameters:

productIds - list of products

Throws:

NullArgumentException - productIds is null

Compliance:

mandatory - This method must be implemented.

orderProductResults

void orderProductResults(ProductSearchOrder productSearchOrder)

Specify an ordering to the search results.

Parameters:

productSearchOrder - product search order

Throws:

NullArgumentException - productSearchOrder is null

UnsupportedException - productSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProductSearchRecord

ProductSearchRecord getProductSearchRecord(Type productSearchRecordType)
                                    throws OperationFailedException

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

Parameters:

productSearchRecordType - a product search record type

Returns:

the product search record

Throws:

NullArgumentException - productSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(productSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.