Interface | osid.dictionary.DictionarySearchSession | ||
---|---|---|---|
Implements | osid.dictionary.DictionaryQuerySession | ||
Description |
This session provides methods for searching Dictionaries may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getDictionarySearch | ||
Description |
Gets a dictionary search. | ||
Return | osid.dictionary.DictionarySearch | the dictionary search | |
Compliance | mandatory | This method must be implemented. | |
Method | getDictionarySearchOrder | ||
Description |
Gets a dictionary search order. The | ||
Return | osid.dictionary.DictionarySearchOrder | the dictionary search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getDictionariesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.dictionary.DictionaryQuery | dictionaryQuery | the dictionary search query |
osid.dictionary.DictionarySearch | dictionarySearch | the dictionary search | |
Return | osid.dictionary.DictionarySearchResults | the returned search results | |
Errors | NULL_ARGUMENT | dictionaryQuery or dictionarySearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | dictionarySearch or dictionaryQuery is not of
this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDictionaryQueryFromInspector | ||
Description |
Gets a dictionary query from an inspector. The
inspector is available from a | ||
Parameters | osid.dictionary.DictionaryQueryInspector | dictionaryQueryInspector | a dictionary query inspector |
Return | osid.dictionary.DictionaryQuery | the dictionary query | |
Errors | NULL_ARGUMENT | dictionaryQueryInspector is null | |
UNSUPPORTED | dictionaryQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |