public interface DictionarySearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
DictionaryList |
getDictionaries()
Gets the dictionary list resulting from the search.
|
DictionaryQueryInspector |
getDictionaryQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
DictionarySearchResultsRecord |
getDictionarySearchResultsRecord(Type dictionarySearchRecordType)
Gets the dictionary search results record corresponding to the given
dictionary search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
DictionaryList getDictionaries()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. DictionaryQueryInspector getDictionaryQueryInspector()
mandatory
- This method must be implemented. DictionarySearchResultsRecord getDictionarySearchResultsRecord(Type dictionarySearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.dictionarySearchRecordType
- a dictionary search record typeNullArgumentException
-
dictionarySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(dictionarySearchRecordType)
is
false
mandatory
- This method must be implemented.