| Interface | osid.dictionary.EntrySearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description | 
                 This interface provides a means to capture results of a search.  | ||
| Method | getEntries | ||
| Description | 
                     Gets the entry list resulting from the search.  | ||
| Return | osid.dictionary.EntryList | the entry list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEntryQueryInspector | ||
| Description | 
                     Gets the inspector for the query to examine the terms used in the search.  | ||
| Return | osid.dictionary.EntryQueryInspector | the entry query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEntrySearchResultsRecord | ||
| Description | 
                     Gets the entry search results record corresponding to 
                    the given entry search record   | ||
| Parameters | osid.type.Type | entrySearchRecordType | an entry search record type | 
| Return | osid.dictionary.records.EntrySearchResultsRecord | the entry search results record | |
| Errors | NULL_ARGUMENT |  entrySearchRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(entrySearchRecordType)  is  false   |                 ||
| Compliance | mandatory | This method must be implemented. | |