Interface RouteSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RouteQuerySession
public interface RouteSearchSession extends RouteQuerySession

This session provides methods for searching among Routes. 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.

Like all OsidSessions, RouteSearchSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getRouteSearch

      RouteSearch getRouteSearch()
      Gets a route search.
      Returns:
      the route search
      Compliance:
      mandatory - This method must be implemented.

    • getRouteSearchOrder

      RouteSearchOrder getRouteSearchOrder()
      Gets a route search order. The RouteSearchOrder is supplied to a RouteSearch to specify the ordering of results.
      Returns:
      the route search order
      Compliance:
      mandatory - This method must be implemented.

    • getRoutesBySearch

      RouteSearchResults getRoutesBySearch(RouteQuery routeQuery, RouteSearch routeSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      routeQuery - the route query
      routeSearch - the route search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - routeQuery or routeSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - routeQuery or routeSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getRouteQueryFromInspector

      RouteQuery getRouteQueryFromInspector(RouteQueryInspector routeQueryInspector)
      Gets a route query from an inspector. The inspector is available from a RouteSearchResults.
      Parameters:
      routeQueryInspector - a route query inspector
      Returns:
      the route query
      Throws:
      NullArgumentException - routeQueryInspector is null
      UnsupportedException - routeQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.