OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
ordering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.ordering.StoreSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getStores | ||
| Description |
Gets the store list resulting from a search. | ||
| Return | osid.ordering.StoreList | the store list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStoreQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.ordering.StoreQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStoreSearchResultsRecord | ||
| Description |
Gets the store search results record corresponding to the given store search record Type. This method is used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | storeSearchRecordType | a store search record type |
| Return | osid.ordering.records.StoreSearchResultsRecord | the store search results 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. | |