| Interface | osid.ordering.StoreSearchSession | ||
|---|---|---|---|
| Implements | osid.ordering.StoreQuerySession | ||
| Description |
This session provides methods for searching Stores may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getStoreSearch | ||
| Description |
Gets a store search. | ||
| Return | osid.ordering.StoreSearch | the store search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStoreSearchOrder | ||
| Description |
Gets a store search order. The | ||
| Return | osid.ordering.StoreSearchOrder | the store search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStoresBySearch | ||
| Description |
Gets the search results matching the given search. | ||
| Parameters | osid.ordering.StoreQuery | storeQuery | the store query |
osid.ordering.StoreSearch | storeSearch | the store search | |
| Return | osid.ordering.StoreSearchResults | the store search results | |
| Errors | NULL_ARGUMENT | storeQuery or storeSearch is null
| |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | storeQuery or storeSearch is not of this
service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getStoreQueryFromInspector | ||
| Description |
Gets an entry query from an inspector. The inspector is
available from an | ||
| Parameters | osid.ordering.StoreQueryInspector | storeQueryInspector | a query inspector |
| Return | osid.ordering.StoreQuery | the store query | |
| Errors | NULL_ARGUMENT | storeQueryInspector is null | |
| UNSUPPORTED | storeQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |