public interface DictionarySearch extends OsidSearch
This interface defines search options.
Modifier and Type | Method and Description |
---|---|
DictionarySearchRecord |
getDictionarySearchRecord(Type dictionarySearchRecordType)
Gets the dictionary search record corresponding to the given
dictionary search record
Type. |
void |
orderDictionaryResults(DictionarySearchOrder dictionarySearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongDictionaries(IdList dictionaryIds)
Execute this search among the given list of dictionaries.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongDictionaries(IdList dictionaryIds)
dictionaryIds
- list of dictionariesNullArgumentException
- dictionaryIds
is
null
mandatory
- This method must be implemented. void orderDictionaryResults(DictionarySearchOrder dictionarySearchOrder)
dictionarySearchOrder
- dictionary search orderNullArgumentException
- dictionarySearchOrder
is null
UnsupportedException
- dictionarySearchOrder
is not of this servicemandatory
- This method must be implemented. DictionarySearchRecord getDictionarySearchRecord(Type dictionarySearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record interface.dictionarySearchRecordType
- a dictionary search record typeNullArgumentException
-
dictionarySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(dictionarySearchRecordType)
is
false
mandatory
- This method must be implemented.