public interface ObstacleSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
ObstacleQueryInspector |
getObstacleQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
ObstacleList |
getObstacles()
Gets the obstacle list resulting from a search.
|
ObstacleSearchResultsRecord |
getObstacleSearchResultsRecord(Type obstacleSearchRecordType)
Gets the record corresponding to the given obstacle search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
ObstacleList getObstacles()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. ObstacleQueryInspector getObstacleQueryInspector()
mandatory
- This method must be implemented. ObstacleSearchResultsRecord getObstacleSearchResultsRecord(Type obstacleSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.obstacleSearchRecordType
- an obstacle search record typeNullArgumentException
- obstacleSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(obstacleSearchRecordType)
is
false
mandatory
- This method must be implemented.