public interface DepotSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
DepotQueryInspector |
getDepotQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
DepotList |
getDepots()
Gets the depot list resulting from the search.
|
DepotSearchResultsRecord |
getDepotSearchResultsRecord(Type depotSearchRecordType)
Gets the depot search results record corresponding to the given depot
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
DepotList getDepots()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. DepotQueryInspector getDepotQueryInspector()
mandatory
- This method must be implemented. DepotSearchResultsRecord getDepotSearchResultsRecord(Type depotSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.depotSearchRecordType
- a depot search record typeNullArgumentException
- depotSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(depotSearchRecordType)
is false
mandatory
- This method must be implemented.