Interface | osid.mapping.route.RouteSearchSession | ||
---|---|---|---|
Implements | osid.mapping.route.RouteQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Routes may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getRouteSearch | ||
Description |
Gets a route search. | ||
Return | osid.mapping.route.RouteSearch | the route search | |
Compliance | mandatory | This method must be implemented. | |
Method | getRouteSearchOrder | ||
Description |
Gets a route search order. The | ||
Return | osid.mapping.route.RouteSearchOrder | the route search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getRoutesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.mapping.route.RouteQuery | routeQuery | the route query |
osid.mapping.route.RouteSearch | routeSearch | the route search | |
Return | osid.mapping.route.RouteSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | routeQuery or routeSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | routeQuery or routeSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRouteQueryFromInspector | ||
Description |
Gets a route query from an inspector. The inspector is
available from a | ||
Parameters | osid.mapping.route.RouteQueryInspector | routeQueryInspector | a route query inspector |
Return | osid.mapping.route.RouteQuery | the route query | |
Errors | NULL_ARGUMENT | routeQueryInspector is null | |
UNSUPPORTED | routeQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |