Interface | osid.search.SearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.search.QueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getSearchResultsRecord | ||
Description |
Gets the search results record corresponding to the
given search record | ||
Parameters | osid.type.Type | searchRecordType | a search record type |
Return | osid.search.records.SearchResultsRecord | the search results record | |
Errors | NULL_ARGUMENT | searchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(searchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |