Interface | osid.dictionary.DictionarySearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
This interface defines search options. | ||
Method | searchAmongDictionaries | ||
Description |
Execute this search among the given list of dictionaries. | ||
Parameters | osid.id.IdList | dictionaryIds | list of dictionaries |
Errors | NULL_ARGUMENT | dictionaryIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderDictionaryResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.dictionary.DictionarySearchOrder | dictionarySearchOrder | dictionary search order |
Errors | NULL_ARGUMENT | dictionarySearchOrder is null | |
UNSUPPORTED | dictionarySearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDictionarySearchRecord | ||
Description |
Gets the dictionary search record corresponding to the
given dictionary search record | ||
Parameters | osid.type.Type | dictionarySearchRecordType | a dictionary search record type |
Return | osid.dictionary.records.DictionarySearchRecord | the dictionary search 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. |