public interface ControllerSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
ControllerQueryInspector |
getControllerQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
ControllerList |
getControllers()
Gets the controller list resulting from a search.
|
ControllerSearchResultsRecord |
getControllerSearchResultsRecord(Type controllerSearchRecordType)
Gets the controller search results record corresponding to the given
controller search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
ControllerList getControllers()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. ControllerQueryInspector getControllerQueryInspector()
mandatory
- This method must be implemented. ControllerSearchResultsRecord getControllerSearchResultsRecord(Type controllerSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.controllerSearchRecordType
- a controller search record typeNullArgumentException
-
controllerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(controllerSearchRecordType)
is
false
mandatory
- This method must be implemented.