public interface ProductSearch extends OsidSearch
The search interface for governing product searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongProducts(IdList productIds)
productIds
- list of productsNullArgumentException
- productIds
is
null
mandatory
- This method must be implemented. void orderProductResults(ProductSearchOrder productSearchOrder)
productSearchOrder
- product search orderNullArgumentException
- productSearchOrder
is null
UnsupportedException
- productSearchOrder
is not of this servicemandatory
- This method must be implemented. ProductSearchRecord getProductSearchRecord(Type productSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.productSearchRecordType
- an product search record typeNullArgumentException
- productSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(productSearchRecordType)
is false
mandatory
- This method must be implemented.