public interface RequestSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
RequestQueryInspector |
getRequestQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
RequestList |
getRequests()
Gets the request list resulting from a search.
|
RequestSearchResultsRecord |
getRequestSearchResultsRecord(Type requestSearchRecordType)
Gets the request search results record corresponding to the given
request search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
RequestList getRequests()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. RequestQueryInspector getRequestQueryInspector()
mandatory
- This method must be implemented. RequestSearchResultsRecord getRequestSearchResultsRecord(Type requestSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.requestSearchRecordType
- a request search record typeNullArgumentException
- requestSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(requestSearchRecordType)
is false
mandatory
- This method must be implemented.