public interface TermSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
TermQueryInspector |
getTermQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
TermList |
getTerms()
Gets the term list resulting from a search.
|
TermSearchResultsRecord |
getTermSearchResultsRecord(Type termSearchRecordType)
Gets the term search results record corresponding to the given term
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
TermList getTerms()
IllegalStateException
- the term list has already been
retrievedmandatory
- This method must be implemented. TermQueryInspector getTermQueryInspector()
mandatory
- This method must be implemented. TermSearchResultsRecord getTermSearchResultsRecord(Type termSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.termSearchRecordType
- a term search record typeNullArgumentException
- termSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(termSearchRecordType)
is false
mandatory
- This method must be implemented.