Interface | osid.dictionary.DictionarySearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getDictionaries | ||
Description |
Gets the dictionary list resulting from the search. | ||
Return | osid.dictionary.DictionaryList | the dictionary list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getDictionaryQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.dictionary.DictionaryQueryInspector | the dictionary query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getDictionarySearchResultsRecord | ||
Description |
Gets the dictionary search results record corresponding
to the given dictionary search record | ||
Parameters | osid.type.Type | dictionarySearchRecordType | a dictionary search record type |
Return | osid.dictionary.records.DictionarySearchResultsRecord | the dictionary search results record | |
Errors | NULL_ARGUMENT | dictionarySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(dictionarySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |