public interface RouteSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
RouteQueryInspector |
getRouteQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
RouteList |
getRoutes()
Gets the route list resulting from a search.
|
RouteSearchResultsRecord |
getRouteSearchResultsRecord(Type routeSearchRecordType)
Gets the route search results record corresponding to the given route
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
RouteList getRoutes()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. RouteQueryInspector getRouteQueryInspector()
mandatory
- This method must be implemented. RouteSearchResultsRecord getRouteSearchResultsRecord(Type routeSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.routeSearchRecordType
- a route search record typeNullArgumentException
- routeSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(routeSearchRecordType)
is false
mandatory
- This method must be implemented.