Interface | osid.ordering.ProductSearchSession | ||
---|---|---|---|
Implements | osid.ordering.ProductQuerySession | ||
Description |
This session provides methods for searching Products may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getProductSearch | ||
Description |
Gets a product search. | ||
Return | osid.ordering.ProductSearch | the product search | |
Compliance | mandatory | This method must be implemented. | |
Method | getProductSearchOrder | ||
Description |
Gets a product search order. The | ||
Return | osid.ordering.ProductSearchOrder | the product search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getProductsBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.ordering.ProductQuery | productQuery | the product query |
osid.ordering.ProductSearch | productSearch | the product search | |
Return | osid.ordering.ProductSearchResults | the product search results | |
Errors | NULL_ARGUMENT | productQuery or productSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | productQuery or productSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProductQueryFromInspector | ||
Description |
Gets a product query from an inspector. The inspector
is available from a | ||
Parameters | osid.ordering.ProductQueryInspector | productQueryInspector | a query inspector |
Return | osid.ordering.ProductQuery | the product query | |
Errors | NULL_ARGUMENT | productQueryInspector is null | |
UNSUPPORTED | productQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |