Interface | osid.mapping.route.RouteSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getRoutes | ||
Description |
Gets the route list resulting from a search. | ||
Return | osid.mapping.route.RouteList | the route list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getRouteQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.mapping.route.RouteQueryInspector | the route query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getRouteSearchResultsRecord | ||
Description |
Gets the route search results record corresponding to
the given route search record | ||
Parameters | osid.type.Type | routeSearchRecordType | a route search record type |
Return | osid.mapping.route.records.RouteSearchResultsRecord | the route search results record | |
Errors | NULL_ARGUMENT | routeSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(routeSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |