public interface SearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
QueryInspector |
getQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
SearchResultsRecord |
getSearchResultsRecord(Type searchRecordType)
Gets the search results record corresponding to the given search
record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
QueryInspector getQueryInspector()
mandatory
- This method must be implemented. SearchResultsRecord getSearchResultsRecord(Type searchRecordType) throws OperationFailedException, PermissionDeniedException
Type.
This method is used to retrieve an object
implementing the requested record.searchRecordType
- a search record typeNullArgumentException
- searchRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(searchRecordType)
is false
mandatory
- This method must be implemented.