OSID Logo
OSID Specifications
mapping route package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.route.RouteSearchSession
Implementsosid.mapping.route.RouteQuerySession
Description

This session provides methods for searching among Route objects. The search query is constructed using the RouteQuery.

getRoutesByQuery() is the basic search method and returns a list of Routes. A more advanced search may be performed with getRoutesBySearch(). It accepts a RouteSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRoutesBySearch() returns a RouteSearchResults that can be used to access the resulting RouteList or be used to perform a search within the result set through RouteSearch.

This session defines views that offer differing behaviors for searching.

  • federated map view: searches include routes in maps of which this map is an ancestor in the map hierarchy
  • isolated map view: searches are restricted to routes in this map

Routes may have a query record indicated by their respective record types. The query record is accessed via the RouteQuery.

MethodgetRouteSearch
Description

Gets a route search.

Returnosid.mapping.route.RouteSearchthe route search
CompliancemandatoryThis method must be implemented.
MethodgetRouteSearchOrder
Description

Gets a route search order. The RouteSearchOrder is supplied to a RouteSearch to specify the ordering of results.

Returnosid.mapping.route.RouteSearchOrderthe route search order
CompliancemandatoryThis method must be implemented.
MethodgetRoutesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.mapping.route.RouteQueryrouteQuerythe route query
osid.mapping.route.RouteSearchrouteSearchthe route search
Returnosid.mapping.route.RouteSearchResultsthe returned search results
ErrorsNULL_ARGUMENT routeQuery or routeSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED routeQuery or routeSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRouteQueryFromInspector
Description

Gets a route query from an inspector. The inspector is available from a RouteSearchResults.

Parametersosid.mapping.route.RouteQueryInspectorrouteQueryInspectora route query inspector
Returnosid.mapping.route.RouteQuerythe route query
ErrorsNULL_ARGUMENT routeQueryInspector is null
UNSUPPORTED routeQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.