| Interface | osid.ordering.StoreSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing store searches. | ||
| Method | searchAmongStores | ||
| Description |
Execute this search among the given list of stores. | ||
| Parameters | osid.id.IdList | storeIds | list of stores |
| Errors | NULL_ARGUMENT | storeIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderStoreResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.ordering.StoreSearchOrder | storesearchOrder | store search order |
| Errors | NULL_ARGUMENT | storesearchOrder is null | |
| UNSUPPORTED | storesearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getStoreSearchRecord | ||
| Description |
Gets the store search record corresponding to the given
store search record | ||
| Parameters | osid.type.Type | storeSearchRecordType | a store search record type |
| Return | osid.ordering.records.StoreSearchRecord | the store search record | |
| Errors | NULL_ARGUMENT | storesearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(storesearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |